1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
|
Roundcube Webmail SAUserPrefs
=============================
This plugin adds the ability for users to edit they SpamAssassin user prefs
from within Roundcube. It interacts with preferences storied in a database via
SQL. For more information on setting up SpamAssassin to work with a database
please see the [SpamAssassin Wiki][usingsql].
Inspiration for this plugin was taken from:
[WebUserPrefs][webuserprefs]
Requirements
------------
* [Roundcube jQueryUI plugin][rcjqui]
* SpamAssassin 3.0 or above
License
-------
This plugin is released under the [GNU General Public License Version 3+][gpl].
Even if skins might contain some programming work, they are not considered
as a linked part of the plugin and therefore skins DO NOT fall under the
provisions of the GPL license. See the README file located in the core skins
folder for details on the skin license.
Install
-------
* Place this plugin folder into plugins directory of Roundcube
* Add sauserprefs to $config['plugins'] in your Roundcube config
**NB:** When downloading the plugin from GitHub you will need to create a
directory called sauserprefs and place the files in there, ignoring the root
directory in the downloaded archive.
Config
------
The default config file is plugins/sauserprefs/config.inc.php.dist
Rename this to plugins/sauserprefs/config.inc.php
* You must set the database connection string
* Enter the table name, name of the username field, preference field, and value
field
SpamAssassin v4
---------------
To enable support for SpamAssassin v4 set `$config['sauserprefs_sav4'] = true;`
in your config file. This replaces old rule names such as `whitelist_from` with
with their v4 equivalent automatically. Note: Some default prefs in your config
file may need to be updated. See SpamAssassin docs for more details.
Supported languages for ok_languages option
-------------------------------------------
Taken from Mail::SpamAssassin::Plugin::TextCat
* af - Afrikaans
* am - Amharic
* ar - Arabic
* be - Byelorussian
* bg - Bulgarian
* bs - Bosnian
* ca - Catalan
* cs - Czech
* cy - Welsh
* da - Danish
* de - German
* el - Greek
* en - English
* eo - Esperanto
* es - Spanish
* et - Estonian
* eu - Basque
* fa - Persian
* fi - Finnish
* fr - French
* fy - Frisian
* ga - Irish Gaelic
* gd - Scottish Gaelic
* he - Hebrew
* hi - Hindi
* hr - Croatian
* hu - Hungarian
* hy - Armenian
* id - Indonesian
* is - Icelandic
* it - Italian
* ja - Japanese
* ka - Georgian
* ko - Korean
* la - Latin
* lt - Lithuanian
* lv - Latvian
* mr - Marathi
* ms - Malay
* ne - Nepali
* nl - Dutch
* no - Norwegian
* pl - Polish
* pt - Portuguese
* qu - Quechua
* rm - Rhaeto-Romance
* ro - Romanian
* ru - Russian
* sa - Sanskrit
* sco - Scots
* sk - Slovak
* sl - Slovenian
* sq - Albanian
* sr - Serbian
* sv - Swedish
* sw - Swahili
* ta - Tamil
* th - Thai
* tl - Tagalog
* tr - Turkish
* uk - Ukrainian
* vi - Vietnamese
* yi - Yiddish
* zh - Chinese (both Traditional and Simplified)
* zh.big5 - Chinese (Traditional only)
* zh.gb2312 - Chinese (Simplified only)
Changing the order of the sections
----------------------------------
To change the order of the sections add a sections attribute with the sections
listed in the desired order to the sasectionslist object in
skins/[skin]/templates/sauserprefs.html. For example:
```html
<roundcube:object name="sasectionslist" id="sections-table"
class="records-table" cellspacing="0"
sections="general,tests,bayes,headers,report,addresses" />
```
Delete user bayesian data stored in database
--------------------------------------------
If the bayesian data is stored in the same database as the user prefs then it
is possible for users to delete their data from the UI.
See config file for example SQL
"SERVICE CURRENTLY NOT AVAILABLE! Error No. [500]" Error Message
----------------------------------------------------------------
On some setups users might see "SERVICE CURRENTLY NOT AVAILABLE! Error No.
[500]" shows up at the top of the sauserprefs screen. In this case there could
be a problem with the database connection. Try adding ?new_link=true to the end
of the sauserprefs DSN in the config file. For example:
```php
$config['sauserprefs_db_dsnw'] =
'mysql://username:password@localhost/database?new_link=true';
```
sauserprefs_save hook
---------------------
Before prefs are saved to the database the plugin hook sauserprefs_save is
executed, this allows you to perform any custom actions like extra validation
or setting specific values.
Arguments:
* section: (string) current prefs section
* cur_prefs: (array) the current user preferences
* new_prefs: (array) the new preferences
* global_prefs: (array) the global preferences
Return:
* new_prefs: (array) the new preferences
* abort: (boolean) if true the prefs will not be saved
* message: (string) optional reason why the prefs were not saved which will be
shown to the user
sauserprefs_sections_list hook
------------------------------
This allows you to modify the sections list.
Arguments:
* list: (array) the current setions array
* cols: (array) column names to display
Return:
* list: (array) the new setions array
* cols: (array) column names to display
sauserprefs_section_name hook
-----------------------------
This allows you to modify the title displayed at top of the preferences screen.
Arguments:
* section: (string) selected section of the prefs
* title: (string) the title for the current section
Return:
* title: (string) the title for the current section
sauserprefs_list hook
---------------------
This allows you to modify the elements of the preferences screen before they
are displayed.
Arguments:
* section: (string) selected section of the prefs
* block: (array) array containing preferences blocks/options
Return:
* block: (array) array containing preferences blocks/options
Replacing the storage class
---------------------------
To replace the default sql storage class with your own you need to set a
special config options:
* sauserprefs_storage: (string) the suffix of the storage class
e.g. 'sql' for the default sql storage class
The Roundcube config object is passed to the constructor of the class
Overriding SpamAssassin test scores
-----------------------------------
An additional "Test Scores" section can be added to the UI to allow overriding
of default test scores (e.g. `score A_HREF_TO_REMOVE 2.0`). To do this add the
scores to the `sauserprefs_default_prefs` array. For example:
```php
$config['sauserprefs_default_prefs'] = [
...
'score SYMBOLIC_TEST_NAME' => 2.0,
];
```
Customizing the Elastic skin
----------------------------
The colors and styles used by this plugin can be overridden by adding a
`_custom.less` file to the `skins/elastic` sub-folder of this plugin and
then recompiling the CSS.
[usingsql]: https://wiki.apache.org/spamassassin/UsingSQL
[webuserprefs]: https://sourceforge.net/projects/webuserprefs/
[rcjqui]: https://github.com/roundcube/roundcubemail/tree/master/plugins/jqueryui
[gpl]: https://www.gnu.org/licenses/gpl.html
|
