CoCalc -- setting.go

GitHub Repository: alist-org/alist
Path: blob/main/internal/bootstrap/data/setting.go
¹⁵⁶² views
1
package data
2

3
import (
4
	"strconv"
5

6
	"github.com/alist-org/alist/v3/cmd/flags"
7
	"github.com/alist-org/alist/v3/internal/conf"
8
	"github.com/alist-org/alist/v3/internal/db"
9
	"github.com/alist-org/alist/v3/internal/model"
10
	"github.com/alist-org/alist/v3/internal/offline_download/tool"
11
	"github.com/alist-org/alist/v3/internal/op"
12
	"github.com/alist-org/alist/v3/pkg/utils"
13
	"github.com/alist-org/alist/v3/pkg/utils/random"
14
	"github.com/pkg/errors"
15
	"gorm.io/gorm"
16
)
17

18
var initialSettingItems []model.SettingItem
19

20
func initSettings() {
21
	InitialSettings()
22
	// check deprecated
23
	settings, err := op.GetSettingItems()
24
	if err != nil {
25
		utils.Log.Fatalf("failed get settings: %+v", err)
26
	}
27
	settingMap := map[string]*model.SettingItem{}
28
	for _, v := range settings {
29
		if !isActive(v.Key) && v.Flag != model.DEPRECATED {
30
			v.Flag = model.DEPRECATED
31
			err = op.SaveSettingItem(&v)
32
			if err != nil {
33
				utils.Log.Fatalf("failed save setting: %+v", err)
34
			}
35
		}
36
		settingMap[v.Key] = &v
37
	}
38
	// create or save setting
39
	save := false
40
	for i := range initialSettingItems {
41
		item := &initialSettingItems[i]
42
		item.Index = uint(i)
43
		if item.PreDefault == "" {
44
			item.PreDefault = item.Value
45
		}
46
		// err
47
		stored, ok := settingMap[item.Key]
48
		if !ok {
49
			stored, err = op.GetSettingItemByKey(item.Key)
50
			if err != nil && !errors.Is(err, gorm.ErrRecordNotFound) {
51
				utils.Log.Fatalf("failed get setting: %+v", err)
52
				continue
53
			}
54
		}
55
		if stored != nil && item.Key != conf.VERSION && stored.Value != item.PreDefault {
56
			item.Value = stored.Value
57
		}
58
		_, err = op.HandleSettingItemHook(item)
59
		if err != nil {
60
			utils.Log.Errorf("failed to execute hook on %s: %+v", item.Key, err)
61
			continue
62
		}
63
		// save
64
		if stored == nil || *item != *stored {
65
			save = true
66
		}
67
	}
68
	if save {
69
		err = db.SaveSettingItems(initialSettingItems)
70
		if err != nil {
71
			utils.Log.Fatalf("failed save setting: %+v", err)
72
		} else {
73
			op.SettingCacheUpdate()
74
		}
75
	}
76
}
77

78
func isActive(key string) bool {
79
	for _, item := range initialSettingItems {
80
		if item.Key == key {
81
			return true
82
		}
83
	}
84
	return false
85
}
86

87
func InitialSettings() []model.SettingItem {
88
	var token string
89
	if flags.Dev {
90
		token = "dev_token"
91
	} else {
92
		token = random.Token()
93
	}
94
	defaultRoleID := strconv.Itoa(model.GUEST)
95
	initialSettingItems = []model.SettingItem{
96
		// site settings
97
		{Key: conf.VERSION, Value: conf.Version, Type: conf.TypeString, Group: model.SITE, Flag: model.READONLY},
98
		//{Key: conf.ApiUrl, Value: "", Type: conf.TypeString, Group: model.SITE},
99
		//{Key: conf.BasePath, Value: "", Type: conf.TypeString, Group: model.SITE},
100
		{Key: conf.SiteTitle, Value: "AList", Type: conf.TypeString, Group: model.SITE},
101
		{Key: conf.Announcement, Value: "### repo\nhttps://github.com/alist-org/alist", Type: conf.TypeText, Group: model.SITE},
102
		{Key: "pagination_type", Value: "all", Type: conf.TypeSelect, Options: "all,pagination,load_more,auto_load_more", Group: model.SITE},
103
		{Key: "default_page_size", Value: "30", Type: conf.TypeNumber, Group: model.SITE},
104
		{Key: conf.AllowIndexed, Value: "false", Type: conf.TypeBool, Group: model.SITE},
105
		{Key: conf.AllowMounted, Value: "true", Type: conf.TypeBool, Group: model.SITE},
106
		{Key: conf.RobotsTxt, Value: "User-agent: *\nAllow: /", Type: conf.TypeText, Group: model.SITE},
107
		{Key: conf.AllowRegister, Value: "false", Type: conf.TypeBool, Group: model.SITE},
108
		{Key: conf.DefaultRole, Value: defaultRoleID, Type: conf.TypeSelect, Group: model.SITE},
109
		// newui settings
110
		{Key: conf.UseNewui, Value: "false", Type: conf.TypeBool, Group: model.SITE},
111
		// style settings
112
		{Key: conf.Logo, Value: "https://cdn.jsdelivr.net/gh/alist-org/logo@main/logo.svg", Type: conf.TypeText, Group: model.STYLE},
113
		{Key: conf.Favicon, Value: "https://cdn.jsdelivr.net/gh/alist-org/logo@main/logo.svg", Type: conf.TypeString, Group: model.STYLE},
114
		{Key: conf.MainColor, Value: "#1890ff", Type: conf.TypeString, Group: model.STYLE},
115
		{Key: "home_icon", Value: "🏠", Type: conf.TypeString, Group: model.STYLE},
116
		{Key: "home_container", Value: "max_980px", Type: conf.TypeSelect, Options: "max_980px,hope_container", Group: model.STYLE},
117
		{Key: "settings_layout", Value: "list", Type: conf.TypeSelect, Options: "list,responsive", Group: model.STYLE},
118
		// preview settings
119
		{Key: conf.TextTypes, Value: "txt,htm,html,xml,java,properties,sql,js,md,json,conf,ini,vue,php,py,bat,gitignore,yml,go,sh,c,cpp,h,hpp,tsx,vtt,srt,ass,rs,lrc", Type: conf.TypeText, Group: model.PREVIEW, Flag: model.PRIVATE},
120
		{Key: conf.AudioTypes, Value: "mp3,flac,ogg,m4a,wav,opus,wma", Type: conf.TypeText, Group: model.PREVIEW, Flag: model.PRIVATE},
121
		{Key: conf.VideoTypes, Value: "mp4,mkv,avi,mov,rmvb,webm,flv,m3u8", Type: conf.TypeText, Group: model.PREVIEW, Flag: model.PRIVATE},
122
		{Key: conf.ImageTypes, Value: "jpg,tiff,jpeg,png,gif,bmp,svg,ico,swf,webp", Type: conf.TypeText, Group: model.PREVIEW, Flag: model.PRIVATE},
123
		//{Key: conf.OfficeTypes, Value: "doc,docx,xls,xlsx,ppt,pptx", Type: conf.TypeText, Group: model.PREVIEW, Flag: model.PRIVATE},
124
		{Key: conf.ProxyTypes, Value: "m3u8,url", Type: conf.TypeText, Group: model.PREVIEW, Flag: model.PRIVATE},
125
		{Key: conf.ProxyIgnoreHeaders, Value: "authorization,referer", Type: conf.TypeText, Group: model.PREVIEW, Flag: model.PRIVATE},
126
		{Key: "external_previews", Value: `{}`, Type: conf.TypeText, Group: model.PREVIEW},
127
		{Key: "iframe_previews", Value: `{
128
	"doc,docx,xls,xlsx,ppt,pptx": {
129
		"Microsoft":"https://view.officeapps.live.com/op/view.aspx?src=$e_url",
130
		"Google":"https://docs.google.com/gview?url=$e_url&embedded=true"
131
	},
132
	"pdf": {
133
		"PDF.js":"https://alist-org.github.io/pdf.js/web/viewer.html?file=$e_url"
134
	},
135
	"epub": {
136
		"EPUB.js":"https://alist-org.github.io/static/epub.js/viewer.html?url=$e_url"
137
	}
138
}`, Type: conf.TypeText, Group: model.PREVIEW},
139
		//		{Key: conf.OfficeViewers, Value: `{
140
		//	"Microsoft":"https://view.officeapps.live.com/op/view.aspx?src=$url",
141
		//	"Google":"https://docs.google.com/gview?url=$url&embedded=true",
142
		//}`, Type: conf.TypeText, Group: model.PREVIEW},
143
		//		{Key: conf.PdfViewers, Value: `{
144
		//	"pdf.js":"https://alist-org.github.io/pdf.js/web/viewer.html?file=$url"
145
		//}`, Type: conf.TypeText, Group: model.PREVIEW},
146
		{Key: "audio_cover", Value: "https://jsd.nn.ci/gh/alist-org/logo@main/logo.svg", Type: conf.TypeString, Group: model.PREVIEW},
147
		{Key: conf.AudioAutoplay, Value: "true", Type: conf.TypeBool, Group: model.PREVIEW},
148
		{Key: conf.VideoAutoplay, Value: "true", Type: conf.TypeBool, Group: model.PREVIEW},
149
		{Key: conf.PreviewArchivesByDefault, Value: "true", Type: conf.TypeBool, Group: model.PREVIEW},
150
		{Key: conf.ReadMeAutoRender, Value: "true", Type: conf.TypeBool, Group: model.PREVIEW},
151
		{Key: conf.FilterReadMeScripts, Value: "true", Type: conf.TypeBool, Group: model.PREVIEW},
152
		// global settings
153
		{Key: conf.HideFiles, Value: "/\\/README.md/i", Type: conf.TypeText, Group: model.GLOBAL},
154
		{Key: "package_download", Value: "true", Type: conf.TypeBool, Group: model.GLOBAL},
155
		{Key: conf.CustomizeHead, PreDefault: `<script src="https://cdnjs.cloudflare.com/polyfill/v3/polyfill.min.js?features=String.prototype.replaceAll"></script>`, Type: conf.TypeText, Group: model.GLOBAL, Flag: model.PRIVATE},
156
		{Key: conf.CustomizeBody, Type: conf.TypeText, Group: model.GLOBAL, Flag: model.PRIVATE},
157
		{Key: conf.LinkExpiration, Value: "0", Type: conf.TypeNumber, Group: model.GLOBAL, Flag: model.PRIVATE},
158
		{Key: conf.SignAll, Value: "true", Type: conf.TypeBool, Group: model.GLOBAL, Flag: model.PRIVATE},
159
		{Key: conf.PrivacyRegs, Value: `(?:(?:\d|[1-9]\d|1\d\d|2[0-4]\d|25[0-5])\.){3}(?:\d|[1-9]\d|1\d\d|2[0-4]\d|25[0-5])
160
([[:xdigit:]]{1,4}(?::[[:xdigit:]]{1,4}){7}|::|:(?::[[:xdigit:]]{1,4}){1,6}|[[:xdigit:]]{1,4}:(?::[[:xdigit:]]{1,4}){1,5}|(?:[[:xdigit:]]{1,4}:){2}(?::[[:xdigit:]]{1,4}){1,4}|(?:[[:xdigit:]]{1,4}:){3}(?::[[:xdigit:]]{1,4}){1,3}|(?:[[:xdigit:]]{1,4}:){4}(?::[[:xdigit:]]{1,4}){1,2}|(?:[[:xdigit:]]{1,4}:){5}:[[:xdigit:]]{1,4}|(?:[[:xdigit:]]{1,4}:){1,6}:)
161
(?U)access_token=(.*)&`,
162
			Type: conf.TypeText, Group: model.GLOBAL, Flag: model.PRIVATE},
163
		{Key: conf.OcrApi, Value: "https://api.alistgo.com/ocr/file/json", Type: conf.TypeString, Group: model.GLOBAL},
164
		{Key: conf.FilenameCharMapping, Value: `{"/": "|"}`, Type: conf.TypeText, Group: model.GLOBAL},
165
		{Key: conf.ForwardDirectLinkParams, Value: "false", Type: conf.TypeBool, Group: model.GLOBAL},
166
		{Key: conf.IgnoreDirectLinkParams, Value: "sign,alist_ts", Type: conf.TypeString, Group: model.GLOBAL},
167
		{Key: conf.WebauthnLoginEnabled, Value: "false", Type: conf.TypeBool, Group: model.GLOBAL, Flag: model.PUBLIC},
168
		{Key: conf.MaxDevices, Value: "0", Type: conf.TypeNumber, Group: model.GLOBAL},
169
		{Key: conf.DeviceEvictPolicy, Value: "deny", Type: conf.TypeSelect, Options: "deny,evict_oldest", Group: model.GLOBAL},
170
		{Key: conf.DeviceSessionTTL, Value: "86400", Type: conf.TypeNumber, Group: model.GLOBAL},
171

172
		// single settings
173
		{Key: conf.Token, Value: token, Type: conf.TypeString, Group: model.SINGLE, Flag: model.PRIVATE},
174
		{Key: conf.SearchIndex, Value: "none", Type: conf.TypeSelect, Options: "database,database_non_full_text,bleve,meilisearch,none", Group: model.INDEX},
175
		{Key: conf.AutoUpdateIndex, Value: "false", Type: conf.TypeBool, Group: model.INDEX},
176
		{Key: conf.IgnorePaths, Value: "", Type: conf.TypeText, Group: model.INDEX, Flag: model.PRIVATE, Help: `one path per line`},
177
		{Key: conf.MaxIndexDepth, Value: "20", Type: conf.TypeNumber, Group: model.INDEX, Flag: model.PRIVATE, Help: `max depth of index`},
178
		{Key: conf.IndexProgress, Value: "{}", Type: conf.TypeText, Group: model.SINGLE, Flag: model.PRIVATE},
179

180
		// SSO settings
181
		{Key: conf.SSOLoginEnabled, Value: "false", Type: conf.TypeBool, Group: model.SSO, Flag: model.PUBLIC},
182
		{Key: conf.SSOLoginPlatform, Type: conf.TypeSelect, Options: "Casdoor,Github,Microsoft,Google,Dingtalk,OIDC", Group: model.SSO, Flag: model.PUBLIC},
183
		{Key: conf.SSOClientId, Value: "", Type: conf.TypeString, Group: model.SSO, Flag: model.PRIVATE},
184
		{Key: conf.SSOClientSecret, Value: "", Type: conf.TypeString, Group: model.SSO, Flag: model.PRIVATE},
185
		{Key: conf.SSOOIDCUsernameKey, Value: "name", Type: conf.TypeString, Group: model.SSO, Flag: model.PRIVATE},
186
		{Key: conf.SSOOrganizationName, Value: "", Type: conf.TypeString, Group: model.SSO, Flag: model.PRIVATE},
187
		{Key: conf.SSOApplicationName, Value: "", Type: conf.TypeString, Group: model.SSO, Flag: model.PRIVATE},
188
		{Key: conf.SSOEndpointName, Value: "", Type: conf.TypeString, Group: model.SSO, Flag: model.PRIVATE},
189
		{Key: conf.SSOJwtPublicKey, Value: "", Type: conf.TypeString, Group: model.SSO, Flag: model.PRIVATE},
190
		{Key: conf.SSOExtraScopes, Value: "", Type: conf.TypeString, Group: model.SSO, Flag: model.PRIVATE},
191
		{Key: conf.SSOAutoRegister, Value: "false", Type: conf.TypeBool, Group: model.SSO, Flag: model.PRIVATE},
192
		{Key: conf.SSODefaultDir, Value: "/", Type: conf.TypeString, Group: model.SSO, Flag: model.PRIVATE},
193
		{Key: conf.SSODefaultPermission, Value: "0", Type: conf.TypeNumber, Group: model.SSO, Flag: model.PRIVATE},
194
		{Key: conf.SSOCompatibilityMode, Value: "false", Type: conf.TypeBool, Group: model.SSO, Flag: model.PUBLIC},
195

196
		// ldap settings
197
		{Key: conf.LdapLoginEnabled, Value: "false", Type: conf.TypeBool, Group: model.LDAP, Flag: model.PUBLIC},
198
		{Key: conf.LdapServer, Value: "", Type: conf.TypeString, Group: model.LDAP, Flag: model.PRIVATE},
199
		{Key: conf.LdapManagerDN, Value: "", Type: conf.TypeString, Group: model.LDAP, Flag: model.PRIVATE},
200
		{Key: conf.LdapManagerPassword, Value: "", Type: conf.TypeString, Group: model.LDAP, Flag: model.PRIVATE},
201
		{Key: conf.LdapUserSearchBase, Value: "", Type: conf.TypeString, Group: model.LDAP, Flag: model.PRIVATE},
202
		{Key: conf.LdapUserSearchFilter, Value: "(uid=%s)", Type: conf.TypeString, Group: model.LDAP, Flag: model.PRIVATE},
203
		{Key: conf.LdapDefaultDir, Value: "/", Type: conf.TypeString, Group: model.LDAP, Flag: model.PRIVATE},
204
		{Key: conf.LdapDefaultPermission, Value: "0", Type: conf.TypeNumber, Group: model.LDAP, Flag: model.PRIVATE},
205
		{Key: conf.LdapLoginTips, Value: "login with ldap", Type: conf.TypeString, Group: model.LDAP, Flag: model.PUBLIC},
206

207
		// s3 settings
208
		{Key: conf.S3AccessKeyId, Value: "", Type: conf.TypeString, Group: model.S3, Flag: model.PRIVATE},
209
		{Key: conf.S3SecretAccessKey, Value: "", Type: conf.TypeString, Group: model.S3, Flag: model.PRIVATE},
210
		{Key: conf.S3Buckets, Value: "[]", Type: conf.TypeString, Group: model.S3, Flag: model.PRIVATE},
211

212
		// ftp settings
213
		{Key: conf.FTPPublicHost, Value: "127.0.0.1", Type: conf.TypeString, Group: model.FTP, Flag: model.PRIVATE},
214
		{Key: conf.FTPPasvPortMap, Value: "", Type: conf.TypeText, Group: model.FTP, Flag: model.PRIVATE},
215
		{Key: conf.FTPProxyUserAgent, Value: "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) " +
216
			"Chrome/87.0.4280.88 Safari/537.36", Type: conf.TypeString, Group: model.FTP, Flag: model.PRIVATE},
217
		{Key: conf.FTPMandatoryTLS, Value: "false", Type: conf.TypeBool, Group: model.FTP, Flag: model.PRIVATE},
218
		{Key: conf.FTPImplicitTLS, Value: "false", Type: conf.TypeBool, Group: model.FTP, Flag: model.PRIVATE},
219
		{Key: conf.FTPTLSPrivateKeyPath, Value: "", Type: conf.TypeString, Group: model.FTP, Flag: model.PRIVATE},
220
		{Key: conf.FTPTLSPublicCertPath, Value: "", Type: conf.TypeString, Group: model.FTP, Flag: model.PRIVATE},
221

222
		// traffic settings
223
		{Key: conf.TaskOfflineDownloadThreadsNum, Value: strconv.Itoa(conf.Conf.Tasks.Download.Workers), Type: conf.TypeNumber, Group: model.TRAFFIC, Flag: model.PRIVATE},
224
		{Key: conf.TaskOfflineDownloadTransferThreadsNum, Value: strconv.Itoa(conf.Conf.Tasks.Transfer.Workers), Type: conf.TypeNumber, Group: model.TRAFFIC, Flag: model.PRIVATE},
225
		{Key: conf.TaskUploadThreadsNum, Value: strconv.Itoa(conf.Conf.Tasks.Upload.Workers), Type: conf.TypeNumber, Group: model.TRAFFIC, Flag: model.PRIVATE},
226
		{Key: conf.TaskCopyThreadsNum, Value: strconv.Itoa(conf.Conf.Tasks.Copy.Workers), Type: conf.TypeNumber, Group: model.TRAFFIC, Flag: model.PRIVATE},
227
		{Key: conf.TaskDecompressDownloadThreadsNum, Value: strconv.Itoa(conf.Conf.Tasks.Decompress.Workers), Type: conf.TypeNumber, Group: model.TRAFFIC, Flag: model.PRIVATE},
228
		{Key: conf.TaskDecompressUploadThreadsNum, Value: strconv.Itoa(conf.Conf.Tasks.DecompressUpload.Workers), Type: conf.TypeNumber, Group: model.TRAFFIC, Flag: model.PRIVATE},
229
		{Key: conf.StreamMaxClientDownloadSpeed, Value: "-1", Type: conf.TypeNumber, Group: model.TRAFFIC, Flag: model.PRIVATE},
230
		{Key: conf.StreamMaxClientUploadSpeed, Value: "-1", Type: conf.TypeNumber, Group: model.TRAFFIC, Flag: model.PRIVATE},
231
		{Key: conf.StreamMaxServerDownloadSpeed, Value: "-1", Type: conf.TypeNumber, Group: model.TRAFFIC, Flag: model.PRIVATE},
232
		{Key: conf.StreamMaxServerUploadSpeed, Value: "-1", Type: conf.TypeNumber, Group: model.TRAFFIC, Flag: model.PRIVATE},
233
	}
234
	initialSettingItems = append(initialSettingItems, tool.Tools.Items()...)
235
	if flags.Dev {
236
		initialSettingItems = append(initialSettingItems, []model.SettingItem{
237
			{Key: "test_deprecated", Value: "test_value", Type: conf.TypeString, Flag: model.DEPRECATED},
238
			{Key: "test_options", Value: "a", Type: conf.TypeSelect, Options: "a,b,c"},
239
			{Key: "test_help", Type: conf.TypeString, Help: "this is a help message"},
240
		}...)
241
	}
242
	return initialSettingItems
243
}
244

245
Product

Resources

Company
