').addClass('content').text(line)
106 | )
107 | .appendTo(ViewLog.viewlog_popup.popup_inner);
108 | });
109 | ViewLog.viewlog_popup.field.show();
110 | } else if ('' != response.data.message) {
111 | alert(response.data.message);
112 | } else {
113 | alert(aspireupdate.unexpected_error);
114 | }
115 | })
116 | .fail(function (response) {
117 | alert(aspireupdate.unexpected_error);
118 | });
119 | },
120 | close() {
121 | ViewLog.viewlog_popup.field.hide();
122 | ViewLog.viewlog_popup.popup_inner.html('');
123 | }
124 | }
125 | }
126 |
127 | class ApiRewrites {
128 | constructor() {
129 | ApiRewrites.host_selector.init();
130 | ApiRewrites.other_hosts.init();
131 | ApiRewrites.api_key.init();
132 | ApiRewrites.enabled_rewrites.init();
133 | }
134 |
135 | static enabled_rewrites = {
136 | field: jQuery('#aspireupdate-settings-field-enable'),
137 | sub_fields: [],
138 | init() {
139 | ApiRewrites.enabled_rewrites.sub_fields = [
140 | ApiRewrites.host_selector,
141 | ApiRewrites.api_key
142 | ];
143 |
144 | ApiRewrites.enabled_rewrites.field.change(function () {
145 | if (jQuery(this).is(':checked')) {
146 | ApiRewrites.enabled_rewrites.show_options();
147 | } else {
148 | ApiRewrites.enabled_rewrites.hide_options();
149 | }
150 | }).change();
151 | },
152 | show_options() {
153 | Fields.show(ApiRewrites.enabled_rewrites.sub_fields);
154 | },
155 | hide_options() {
156 | Fields.hide(ApiRewrites.enabled_rewrites.sub_fields);
157 | }
158 | }
159 |
160 | static host_selector = {
161 | field: jQuery('#aspireupdate-settings-field-api_host'),
162 | init() {
163 | ApiRewrites.host_selector.field.change(function () {
164 | let selected_option = ApiRewrites.host_selector.field.find(":selected");
165 | if ('other' === selected_option.val()) {
166 | ApiRewrites.other_hosts.show();
167 | } else {
168 | ApiRewrites.other_hosts.hide();
169 | }
170 |
171 | if (ApiRewrites.host_selector.is_api_key_required()) {
172 | ApiRewrites.api_key.make_required();
173 | } else {
174 | ApiRewrites.api_key.remove_required();
175 | }
176 |
177 | if (ApiRewrites.host_selector.has_api_key_url()) {
178 | ApiRewrites.api_key.show_action_button();
179 | } else {
180 | ApiRewrites.api_key.hide_action_button();
181 | }
182 | }).change();
183 | },
184 | is_api_key_required() {
185 | let is_api_rewrites_enabled = jQuery('#aspireupdate-settings-field-enable').is(':checked');
186 | let selected_option = ApiRewrites.host_selector.field.find(":selected");
187 | let require_api_key = selected_option.attr('data-require-api-key');
188 | if (is_api_rewrites_enabled && 'true' === require_api_key) {
189 | return true;
190 | }
191 | return false;
192 | },
193 | has_api_key_url() {
194 | let selected_option = ApiRewrites.host_selector.field.find(":selected");
195 | let api_url = selected_option.attr('data-api-key-url');
196 | if ('' !== api_url) {
197 | return true;
198 | }
199 | return false;
200 | },
201 | get_api_key_url() {
202 | let selected_option = ApiRewrites.host_selector.field.find(":selected");
203 | let api_url = selected_option.attr('data-api-key-url');
204 | if ('' !== api_url) {
205 | return api_url;
206 | }
207 | return '';
208 | },
209 | }
210 |
211 | static other_hosts = {
212 | field: jQuery('#aspireupdate-settings-field-api_host_other'),
213 | init() {
214 | ApiRewrites.other_hosts.field.on("blur", function () {
215 | let value = ApiRewrites.other_hosts.field.val();
216 | value = ApiRewrites.other_hosts.strip_protocol(value);
217 | value = ApiRewrites.other_hosts.strip_dangerous_characters(value);
218 | ApiRewrites.other_hosts.field.val(value);
219 | });
220 | },
221 | show() {
222 | ApiRewrites.other_hosts.field.parent().show();
223 | ApiRewrites.other_hosts.field.focus();
224 | ApiRewrites.other_hosts.make_required();
225 | },
226 | hide() {
227 | ApiRewrites.other_hosts.field.parent().hide();
228 | ApiRewrites.other_hosts.remove_required();
229 | },
230 | make_required() {
231 | ApiRewrites.other_hosts.field.prop('required', true);
232 | },
233 | remove_required() {
234 | ApiRewrites.other_hosts.field.prop('required', false);
235 | },
236 | strip_protocol(value) {
237 | const protocol_regex = /^(https?|ftp|sftp|smtp|ftps|file):\/\/|^www\./i;
238 | return value.replace(protocol_regex, '');
239 | },
240 | strip_dangerous_characters(value) {
241 | const dangerous_characters_regex = /[<>/"'&;]/g;
242 | return value.replace(dangerous_characters_regex, '');
243 | }
244 | }
245 |
246 | static api_key = {
247 | field: jQuery('#aspireupdate-settings-field-api_key'),
248 | action_button: jQuery('#aspireupdate-generate-api-key'),
249 | init() {
250 | ApiRewrites.api_key.action_button.click(function () {
251 | ApiRewrites.api_key.hide_error();
252 | ApiRewrites.api_key.get_api_key();
253 | });
254 | ApiRewrites.api_key.hide_error();
255 | },
256 | get_api_key() {
257 | let parameters = {
258 | "url": ApiRewrites.host_selector.get_api_key_url(),
259 | "type": "POST",
260 | "contentType": 'application/json',
261 | "data": JSON.stringify({
262 | "domain": aspireupdate.domain
263 | })
264 | };
265 | jQuery.ajax(parameters)
266 | .done(function (response) {
267 | ApiRewrites.api_key.field.val(response.apikey);
268 | })
269 | .fail(function (response) {
270 | if ((response.status === 400) || (response.status === 401)) {
271 | ApiRewrites.api_key.show_error(response.responseJSON?.error);
272 | } else {
273 | ApiRewrites.api_key.show_error(aspireupdate.unexpected_error + ' : ' + response.status);
274 | }
275 | });
276 | },
277 | show() {
278 | ApiRewrites.api_key.field.parent().parent().parent().show();
279 | },
280 | hide() {
281 | ApiRewrites.api_key.field.parent().parent().parent().hide();
282 | },
283 | show_action_button() {
284 | ApiRewrites.api_key.action_button.show();
285 | },
286 | hide_action_button() {
287 | ApiRewrites.api_key.action_button.hide();
288 | },
289 | make_required() {
290 | ApiRewrites.api_key.field.prop('required', true);
291 | },
292 | remove_required() {
293 | ApiRewrites.api_key.field.prop('required', false);
294 | },
295 | show_error(message) {
296 | ApiRewrites.api_key.field.parent().find('.error').html(message).show();
297 | },
298 | hide_error() {
299 | ApiRewrites.api_key.field.parent().find('.error').html('').hide();
300 | }
301 | }
302 | }
303 |
304 | class ApiDebug {
305 | constructor() {
306 | ApiDebug.enabled_debug.init();
307 | }
308 |
309 | static enabled_debug = {
310 | field: jQuery('#aspireupdate-settings-field-enable_debug'),
311 | sub_fields: [],
312 | init() {
313 | ApiDebug.enabled_debug.sub_fields = [
314 | ApiDebug.debug_type,
315 | ApiDebug.disable_ssl_verification,
316 | ];
317 |
318 | ApiDebug.enabled_debug.field.change(function () {
319 | if (jQuery(this).is(':checked')) {
320 | ApiDebug.enabled_debug.show_options();
321 | } else {
322 | ApiDebug.enabled_debug.hide_options();
323 | }
324 | }).change();
325 | },
326 | show_options() {
327 | Fields.show(ApiDebug.enabled_debug.sub_fields);
328 | ViewLog.viewlog_button.show();
329 | ClearLog.clearlog_button.show();
330 | },
331 | hide_options() {
332 | Fields.hide(ApiDebug.enabled_debug.sub_fields);
333 | ViewLog.viewlog_button.hide();
334 | ClearLog.clearlog_button.hide();
335 | }
336 | }
337 |
338 | static debug_type = {
339 | field: jQuery('.aspireupdate-settings-field-wrapper-enable_debug_type'),
340 | }
341 |
342 | static disable_ssl_verification = {
343 | field: jQuery('#aspireupdate-settings-field-disable_ssl_verification'),
344 | }
345 | }
346 |
347 | class Fields {
348 | static show(sub_fields) {
349 | jQuery.each(sub_fields, function (index, sub_field) {
350 | sub_field.field.closest('tr').show().addClass('glow-reveal');
351 | sub_field.field.change();
352 | setTimeout(function () {
353 | sub_field.field.closest('tr').removeClass('glow-reveal');
354 | }, 500);
355 | });
356 | }
357 |
358 | static hide(sub_fields) {
359 | jQuery.each(sub_fields, function (index, sub_field) {
360 | sub_field.field.closest('tr').hide();
361 | sub_field.field.change();
362 | });
363 | }
364 | }
365 |
366 |
--------------------------------------------------------------------------------
/includes/views/voltron.txt:
--------------------------------------------------------------------------------
1 |
2 | ...................................................................................................:?%,.............................................................................
3 | .................................................................................................,;*%:..............................................................................
4 | ...............................................................................................,++?+,...............................................................................
5 | ..............................................................................................;**?+.................................................................................
6 | ............................................................................................:*+;?;:++++:,...........................................................................
7 | ..........................................................................................:*+:;%*++::;;;+++:........................................................................
8 | ........................................................................................,+*:,+S*::+%#@#+.,*?........................................................................
9 | ......................................................................................,+*;,.,;:;?#@@@%;,;*+,........................................................................
10 | ....................................................................................,+*;:..,+?S@@@@@%,.+*,..........................................................................
11 | ...................................................................................:*+:*+,;:*#@@@@@@?.;*,...........................................................................
12 | .................................................................................,+*:;?;:?*%.;S@@@@#+.++............................................................................
13 | ...............................................................................,*+::?S:;%:,%:,%@@@@#?.++............................................................................
14 | .............................................................................,+*;,*@%,;%:.,%:,?@@@@@%.++............................................................................
15 | ............................................................................;*;,+#@?,+%:..,%::%@@@@@?.++............................................................................
16 | ..........................................................................:*+,;S@@*,*?,...,%,:S@@@@@?.++............................................................................
17 | ........................................................................,**::%@@#;,?%+;;;;+?.:S@@@@@?.;*:;;;:.......................................................................
18 | ......................................................................,+*::?##@S::%??;,::::,,;S#####?,,::;;;%;......................................................................
19 | .....................................................................;*;,+S###%,:%??::?SSS%%SS#######SS%SS%:,?+.....................................................................
20 | ...................................................................:*;,+S####?,;%%*,+S#####################S;,*+....................................................................
21 | .................................................................:*+::%##S##*,+%?+,*#SSSSSSSSSSSSSSSSSSSSSSSS+,**,..................................................................
22 | ...............................................................,+*::?#SSSS#+,*%%;,?#SSSSS?*?#SSSSSSS##%SSSSSSS*,+*,.................................................................
23 | .............................................................,+*:,*SSSSSSS;,?S?::%SSSSSS*,.*@SSSSSSS@S.+SSSSSSS?,;?:.........................................................,;;;;;:
24 | ............................................................;*;,+SSSSSS#S::%S?,.???%??%+,.,%#%SSSSSS#S..+SSSSSSS%,:?:.......................................................:%;;;;;S
25 | ..........................................................:*+,;%#S%%%%#%,:%?%;:;;;;;:,,,:,,S#%%%%%%S@S,..,;++;;++;:;S;.....................................................,?+,?S+.%
26 | ++:::::::::::::::::::::::::::;;.........................:*+,:?SS%%%%%#?,;%:,::::::+%,.,%S,,@S%%%%%%S@#?+;,:+?%*+;;::;:.....................................................;S.+#S*,%
27 | :?*,,,;+++++++++++++++++++++;,*+......................,+*:,*SS%%%%%S#*,*%,.......;?,+*,S%,;@S%%%%%%S@#%%S%?+;:;++;:.................................,+;...................,%;:%SS*,%
28 | ..+?;.:%#SSSSSSSSSSSSSSSSSSS%;,?;...................,;*;,*SS%%%%%%S#;,??,.......;?,+@S:;:,*@%%%%%%%S@#%%%%%%S%*;:;+*+;,................:*;..........;%S+..................+?.+#%S*,%
29 | ...,+*:.;SS%%%%%%%%%%%%%%%%%%%::?:.................;*;,;%S%%%%%%%SS:,%*........*?,+#SS;..,%#%%%%%%%S@#%%%%%%%%%S%?+;:;+*+:,..........:*+;?*,........;?:*?,...............,S::S%%S*,%
30 | .....:*+,,*SS%%%%%%%%%%%%%%%%S?,+*,..............:*+,:%S%%%%%%%%#%::%+........+?,+#%%#+.,,##%%%%%%%S@#%%%%%%%%%%%%%%%*+::;++;:,....,+*:,;:+?;.......;?:.;%:..............?*,?S%%S*,%
31 | .......+?;.:%#S%%%%%%%%%%%%%%%S*.*+............:++,:?#S%%%%%%%%#?,;%;........+*,+#%%%#?,.,@S%%%%%%%S@#%%%%%%%%%%%%%%%%%%?*;:;+*+::+*;,+%S%;:?*,.....;?:.::?+............;%,:#%%%S*,%
32 | ........,+*:.;SS%%%%%%%%%%%%%%%S+.?;.........,+*:,*SS%%%%%%%%S#*.+%:........+*,*#%%%%S%:.+@%%%%%%%%S@#%%%%%%%%%%%%%%%%%%%%S%?;::;;;,:%S%%%S*,+?;....;?:.#*,??,.........,%+,%S%%%S*,%
33 | ..........:**,,*SS%%%%%%%%%%%%%SS:,?:......,;*;,+SS%%%%%%%%%S#+,*%:.......,**,*#%%%%%%#;.*#%%%%%%%%S@#%%%%%%%%S@##S%%%%%%%%%%%%?*;;?S%%%%%%S%::?*,..;?:.#S?:+%;........+?,+#%%%%S+,%
34 | ...........,;*;.:?#%%%%%%%%%%%%%S%,:%,....;*;,;%S%%%%%%%%%%SS;,*+,.......,**,*#%%%%%%%@+.%#%%%%%%%%%@#%%%%%%%%S@@@@#%%%%%%%%%%%S@@S%????????%S+,+?;.;?:.#%%%;;%+......,%;,S%%%%%S+,%
35 | .............,*?:.+S?????????????S?,;?,.:++,:?S%??????????S@;.;*.........**,*#%???????#?,#S?????????@#????????%@@S????????????S@#%????????????%?::?*;?:.#???%+:?*,....*?,*S?????S;.%
36 | ...............:%+.;S?************S*.+?**:,*S%***********SS%?:,?+......,**,*#?********%%;@?*********@#********?S?***********%@#%***************?%+,+S%:.#?***?*:*?:..:%;,S?*****S;.%
37 | ................,%+.+S*++++++++++++S;,+:,*S?*++++++++++*S%*+?%;,**....,?*.*#?+++++++++*S*#*++++++++*@#*+++++++++++++++++++?#@%*++++++++?*++++++++?*:;+,.#*++++*?:;%;.*?.??++++++S;.%
38 | .................,%;.*%+;++++;;;;;;+S,.;%%+;;;;;;;;;;;*#?;++;+S+,**,.,?+.*#*;++++++++;;#SS++++++++++##+++++++++++++;;;;;*S@%+;;+++;;;+?@S*;;+++++;+?;...#+++++;+*+:?%%,;?+;;;;;;%;.%
39 | ..................:%:,*?;;;;;;;;;;;;*S?%+;;;;;;;;;;;;?S+;;;;;;;%*,**:?+.*#+;;;;;;;;;;;*#@%;;;;;;;;;+##;;;;;;;;;;;;;;;;;?#S*;;;;;;;;;?#@@@@*;;;;;;;;;?*,.#;;;;;;;;**:+;,?*;;;;;;;%;.%
40 | ...................;?:,??::::::::::::*+:::::::::::::%S;::::::::;?*,+%;.?#+::::::::::;%@@@*:::::::::+##;::::::::::::::*S#*:::::::::;S@@@@@@#*:::::::::+?:#:::::::::;*;.+?;:::::::%;.%
41 | ....................;?,,?*::::::::::::::::::::::::;%?:::::*%;::::??,..?#+::::::::::*#@@@@;:::::::::;#S:::::::::::::::%@*::::::::;?@@@@@@@@@@?::::::::::%@:::::::::::**%+::::::::%;.%
42 | .....................+*,,%*::::::::::::::::::::::+S?:::::*@@%;::::*?:?#+:::::::::;%@@@@@@;:::::::::;##;:::::::::::::::?#?:::::::;S@@@@@@@@@@@+::::::::+#@::::::::::::*?:::::::::?;.%
43 | .....................,**,,S+::::::::::::::::::::*S*:;;;:*#@@@S;;;;:*##+:::::::::*#@@@@@@S;:::::::::;##;::::;;;+::::::::?@S+::::::;?@@@@@@@@#*;;:::::;%%*@;::::::::::::::::::::::*:.%
44 | .......................?+.:%*;;;;;;;;;;;;;;;;;+*SS;;;;;+#@@@@@*+++;*S*;;;;;;;;+S@@@@@@@@%+;;;;;;;;;+@#+;;;;;;+%?;;;;;;;;?@@?+;;;;;;*S@@@@@%+;;;;;;;?S*,:@+;;;;++;;;;;;;;;;;;;;;;?;.%
45 | .......................,?;.:S?+++++++++++++*+*?;,?%*+***%@@@@%***+?S?+++++++*%@@@@@@@@@@?++++++++++*@#*++++++*S@?++++++++?#@S*++++++*%@@#?+++++++*S%:..:@*++++?S?+++++++++++++++%;.%
46 | ........................:%;.;S?*************??:,:.*S????*%@@%???*?#%*???????#@@@@@@####@?*??????????@#?*????*?S@#?*****?**?#@@%*????**?%?*??????%S+,**,:@???*%?:*%???***********%;.%
47 | .........................:%:.;#%%%%%%%%%%%%%?,;%?+.;SS%%%%%%%%%%%#S%%%%%%%%SSS%%%%%%%?S#%%%%%%%%%%%%@@%%%%%%%%S@@#%%%%%%%%%%#@@S%%%%%%%%%%%%%%%#%::*%*,:@%%%S?,,,;S%%%%%%%%%%%%%S;.%
48 | ..........................:%:.+#SSSSSSSSSSS*,+?,,**,:%#SSSSSSSSS@#SSSSSSSSSS%SSSSSSSSS##SSSSSSSSSS%S@@SSSSSSSSS@@@#SSSSSSSSSS#@@@SS%SSSSSSS%S##+,+*,;*,:@SSSS:,%%::%SSSSSSSSSSSSS;.S
49 | ...........................:%,.*#SSSSSSSSS+,**,...+?:,?#SSSSSS#@#SSSSSSSSSSSSSSSSSSSS#@#SSSSSSSSSSS#@@SSSSSSSS#@@@@#SSSSSSSSSS#@@@@SSSSSSSS##?,:*+..;+,:@SS#;,%+;%;,?#SSSSSSSSSS#:.#
50 | ............................;?,.?@######S;,?+......:?;.+##S#S#@#S####################@@#S###########@@#SSSSSSS#@@@@@#SSSSSSSSSS#@@@@##S#S#@S;,+*:...;+,:@##*,?*,.,?*,+##SSSSSSS##:.#
51 | .............................+?,,%@####%::?;........,*+.;S###@@#####################@@@#############@@#########@@@@@@############@@@@@###@?,:?+.....;+,:@@?,*?,....*?,;S#########:.#
52 | .............................,**,,%@##?,;?:...........+*,,%@#%%%%%%%%%%%%%%%%%%%%%%%%S@#############@#########################@@@@@@@@@#S+,+?:......;+,,?*,+%,......;?::%########;.#
53 | ..............................,*+.,%@*,+*,.............;?:,+:.,,,,,,,,,,,,,,,,,,,,...;##############%,::::::::::::::::::::::::;;;;;;;;;:,:*+,.......;*+;;;+?:........;%+,?######S:.#
54 | ...............................,?+.,;,**,...............:?+.,*;;;;;;;;;;;;;;;;;;;+?,.*@@@@@@@@@@@@@@?..**;;;;;;;;;;;;;;;;::::::::::::::::+:.........,::::::,..........:?*,+#@@@@%:.#
55 | ................................,%;.,?+..................,**?;...................,#..+@@@@@@@@@@@@@@?..*+..............................................................,*?,:S@@@%:.#
56 | .................................:%+?:.....................;:....................,++,.+#@@@@@@@@@@@@S..*;................................................................;%:,%@@%:.#
57 | ..................................:+,..............................................;?:.:S@@@@@@@@@@@%..*+.................................................................:%+,*@S:.#
58 | ....................................................................................:?;.,%@@@@@@@@@@+.:?:..................................................................,?*,+?:.#
59 | .....................................................................................,?+.,?@@@@@@@@%,;?;....................................................................,*?:.,.#
60 | ......................................................................................,**,.+@@@@@@*,;?:.......................................................................;%;..#
61 | ........................................................................................;?:.;#@@#+.+?,.........................................................................:%+.#
62 | .........................................................................................:?;.:S#;.*?,...........................................................................,?*#
63 | ..........................................................................................,**,,,,**..............................................................................,*S
64 | ............................................................................................+?,,?+.................................................................................,
65 | .............................................................................................;?%;...................................................................................
66 |
67 |
--------------------------------------------------------------------------------
/LICENSE.md:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 2, June 1991
3 |
4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
5 |
6 | Everyone is permitted to copy and distribute verbatim copies
7 | of this license document, but changing it is not allowed.
8 |
9 | Preamble
10 |
11 | The licenses for most software are designed to take away your
12 | freedom to share and change it. By contrast, the GNU General Public
13 | License is intended to guarantee your freedom to share and change free
14 | software--to make sure the software is free for all its users. This
15 | General Public License applies to most of the Free Software
16 | Foundation's software and to any other program whose authors commit to
17 | using it. (Some other Free Software Foundation software is covered by
18 | the GNU Lesser General Public License instead.) You can apply it to
19 | your programs, too.
20 |
21 | When we speak of free software, we are referring to freedom, not
22 | price. Our General Public Licenses are designed to make sure that you
23 | have the freedom to distribute copies of free software (and charge for
24 | this service if you wish), that you receive source code or can get it
25 | if you want it, that you can change the software or use pieces of it
26 | in new free programs; and that you know you can do these things.
27 |
28 | To protect your rights, we need to make restrictions that forbid
29 | anyone to deny you these rights or to ask you to surrender the rights.
30 | These restrictions translate to certain responsibilities for you if you
31 | distribute copies of the software, or if you modify it.
32 |
33 | For example, if you distribute copies of such a program, whether
34 | gratis or for a fee, you must give the recipients all the rights that
35 | you have. You must make sure that they, too, receive or can get the
36 | source code. And you must show them these terms so they know their
37 | rights.
38 |
39 | We protect your rights with two steps: (1) copyright the software, and
40 | (2) offer you this license which gives you legal permission to copy,
41 | distribute and/or modify the software.
42 |
43 | Also, for each author's protection and ours, we want to make certain
44 | that everyone understands that there is no warranty for this free
45 | software. If the software is modified by someone else and passed on, we
46 | want its recipients to know that what they have is not the original, so
47 | that any problems introduced by others will not reflect on the original
48 | authors' reputations.
49 |
50 | Finally, any free program is threatened constantly by software
51 | patents. We wish to avoid the danger that redistributors of a free
52 | program will individually obtain patent licenses, in effect making the
53 | program proprietary. To prevent this, we have made it clear that any
54 | patent must be licensed for everyone's free use or not licensed at all.
55 |
56 | The precise terms and conditions for copying, distribution and
57 | modification follow.
58 |
59 | GNU GENERAL PUBLIC LICENSE
60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
61 |
62 | 0. This License applies to any program or other work which contains
63 | a notice placed by the copyright holder saying it may be distributed
64 | under the terms of this General Public License. The "Program", below,
65 | refers to any such program or work, and a "work based on the Program"
66 | means either the Program or any derivative work under copyright law:
67 | that is to say, a work containing the Program or a portion of it,
68 | either verbatim or with modifications and/or translated into another
69 | language. (Hereinafter, translation is included without limitation in
70 | the term "modification".) Each licensee is addressed as "you".
71 |
72 | Activities other than copying, distribution and modification are not
73 | covered by this License; they are outside its scope. The act of
74 | running the Program is not restricted, and the output from the Program
75 | is covered only if its contents constitute a work based on the
76 | Program (independent of having been made by running the Program).
77 | Whether that is true depends on what the Program does.
78 |
79 | 1. You may copy and distribute verbatim copies of the Program's
80 | source code as you receive it, in any medium, provided that you
81 | conspicuously and appropriately publish on each copy an appropriate
82 | copyright notice and disclaimer of warranty; keep intact all the
83 | notices that refer to this License and to the absence of any warranty;
84 | and give any other recipients of the Program a copy of this License
85 | along with the Program.
86 |
87 | You may charge a fee for the physical act of transferring a copy, and
88 | you may at your option offer warranty protection in exchange for a fee.
89 |
90 | 2. You may modify your copy or copies of the Program or any portion
91 | of it, thus forming a work based on the Program, and copy and
92 | distribute such modifications or work under the terms of Section 1
93 | above, provided that you also meet all of these conditions:
94 |
95 | a) You must cause the modified files to carry prominent notices
96 | stating that you changed the files and the date of any change.
97 |
98 | b) You must cause any work that you distribute or publish, that in
99 | whole or in part contains or is derived from the Program or any
100 | part thereof, to be licensed as a whole at no charge to all third
101 | parties under the terms of this License.
102 |
103 | c) If the modified program normally reads commands interactively
104 | when run, you must cause it, when started running for such
105 | interactive use in the most ordinary way, to print or display an
106 | announcement including an appropriate copyright notice and a
107 | notice that there is no warranty (or else, saying that you provide
108 | a warranty) and that users may redistribute the program under
109 | these conditions, and telling the user how to view a copy of this
110 | License. (Exception: if the Program itself is interactive but
111 | does not normally print such an announcement, your work based on
112 | the Program is not required to print an announcement.)
113 |
114 | These requirements apply to the modified work as a whole. If
115 | identifiable sections of that work are not derived from the Program,
116 | and can be reasonably considered independent and separate works in
117 | themselves, then this License, and its terms, do not apply to those
118 | sections when you distribute them as separate works. But when you
119 | distribute the same sections as part of a whole which is a work based
120 | on the Program, the distribution of the whole must be on the terms of
121 | this License, whose permissions for other licensees extend to the
122 | entire whole, and thus to each and every part regardless of who wrote it.
123 |
124 | Thus, it is not the intent of this section to claim rights or contest
125 | your rights to work written entirely by you; rather, the intent is to
126 | exercise the right to control the distribution of derivative or
127 | collective works based on the Program.
128 |
129 | In addition, mere aggregation of another work not based on the Program
130 | with the Program (or with a work based on the Program) on a volume of
131 | a storage or distribution medium does not bring the other work under
132 | the scope of this License.
133 |
134 | 3. You may copy and distribute the Program (or a work based on it,
135 | under Section 2) in object code or executable form under the terms of
136 | Sections 1 and 2 above provided that you also do one of the following:
137 |
138 | a) Accompany it with the complete corresponding machine-readable
139 | source code, which must be distributed under the terms of Sections
140 | 1 and 2 above on a medium customarily used for software interchange; or,
141 |
142 | b) Accompany it with a written offer, valid for at least three
143 | years, to give any third party, for a charge no more than your
144 | cost of physically performing source distribution, a complete
145 | machine-readable copy of the corresponding source code, to be
146 | distributed under the terms of Sections 1 and 2 above on a medium
147 | customarily used for software interchange; or,
148 |
149 | c) Accompany it with the information you received as to the offer
150 | to distribute corresponding source code. (This alternative is
151 | allowed only for noncommercial distribution and only if you
152 | received the program in object code or executable form with such
153 | an offer, in accord with Subsection b above.)
154 |
155 | The source code for a work means the preferred form of the work for
156 | making modifications to it. For an executable work, complete source
157 | code means all the source code for all modules it contains, plus any
158 | associated interface definition files, plus the scripts used to
159 | control compilation and installation of the executable. However, as a
160 | special exception, the source code distributed need not include
161 | anything that is normally distributed (in either source or binary
162 | form) with the major components (compiler, kernel, and so on) of the
163 | operating system on which the executable runs, unless that component
164 | itself accompanies the executable.
165 |
166 | If distribution of executable or object code is made by offering
167 | access to copy from a designated place, then offering equivalent
168 | access to copy the source code from the same place counts as
169 | distribution of the source code, even though third parties are not
170 | compelled to copy the source along with the object code.
171 |
172 | 4. You may not copy, modify, sublicense, or distribute the Program
173 | except as expressly provided under this License. Any attempt
174 | otherwise to copy, modify, sublicense or distribute the Program is
175 | void, and will automatically terminate your rights under this License.
176 | However, parties who have received copies, or rights, from you under
177 | this License will not have their licenses terminated so long as such
178 | parties remain in full compliance.
179 |
180 | 5. You are not required to accept this License, since you have not
181 | signed it. However, nothing else grants you permission to modify or
182 | distribute the Program or its derivative works. These actions are
183 | prohibited by law if you do not accept this License. Therefore, by
184 | modifying or distributing the Program (or any work based on the
185 | Program), you indicate your acceptance of this License to do so, and
186 | all its terms and conditions for copying, distributing or modifying
187 | the Program or works based on it.
188 |
189 | 6. Each time you redistribute the Program (or any work based on the
190 | Program), the recipient automatically receives a license from the
191 | original licensor to copy, distribute or modify the Program subject to
192 | these terms and conditions. You may not impose any further
193 | restrictions on the recipients' exercise of the rights granted herein.
194 | You are not responsible for enforcing compliance by third parties to
195 | this License.
196 |
197 | 7. If, as a consequence of a court judgment or allegation of patent
198 | infringement or for any other reason (not limited to patent issues),
199 | conditions are imposed on you (whether by court order, agreement or
200 | otherwise) that contradict the conditions of this License, they do not
201 | excuse you from the conditions of this License. If you cannot
202 | distribute so as to satisfy simultaneously your obligations under this
203 | License and any other pertinent obligations, then as a consequence you
204 | may not distribute the Program at all. For example, if a patent
205 | license would not permit royalty-free redistribution of the Program by
206 | all those who receive copies directly or indirectly through you, then
207 | the only way you could satisfy both it and this License would be to
208 | refrain entirely from distribution of the Program.
209 |
210 | If any portion of this section is held invalid or unenforceable under
211 | any particular circumstance, the balance of the section is intended to
212 | apply and the section as a whole is intended to apply in other
213 | circumstances.
214 |
215 | It is not the purpose of this section to induce you to infringe any
216 | patents or other property right claims or to contest validity of any
217 | such claims; this section has the sole purpose of protecting the
218 | integrity of the free software distribution system, which is
219 | implemented by public license practices. Many people have made
220 | generous contributions to the wide range of software distributed
221 | through that system in reliance on consistent application of that
222 | system; it is up to the author/donor to decide if he or she is willing
223 | to distribute software through any other system and a licensee cannot
224 | impose that choice.
225 |
226 | This section is intended to make thoroughly clear what is believed to
227 | be a consequence of the rest of this License.
228 |
229 | 8. If the distribution and/or use of the Program is restricted in
230 | certain countries either by patents or by copyrighted interfaces, the
231 | original copyright holder who places the Program under this License
232 | may add an explicit geographical distribution limitation excluding
233 | those countries, so that distribution is permitted only in or among
234 | countries not thus excluded. In such case, this License incorporates
235 | the limitation as if written in the body of this License.
236 |
237 | 9. The Free Software Foundation may publish revised and/or new versions
238 | of the General Public License from time to time. Such new versions will
239 | be similar in spirit to the present version, but may differ in detail to
240 | address new problems or concerns.
241 |
242 | Each version is given a distinguishing version number. If the Program
243 | specifies a version number of this License which applies to it and "any
244 | later version", you have the option of following the terms and conditions
245 | either of that version or of any later version published by the Free
246 | Software Foundation. If the Program does not specify a version number of
247 | this License, you may choose any version ever published by the Free Software
248 | Foundation.
249 |
250 | 10. If you wish to incorporate parts of the Program into other free
251 | programs whose distribution conditions are different, write to the author
252 | to ask for permission. For software which is copyrighted by the Free
253 | Software Foundation, write to the Free Software Foundation; we sometimes
254 | make exceptions for this. Our decision will be guided by the two goals
255 | of preserving the free status of all derivatives of our free software and
256 | of promoting the sharing and reuse of software generally.
257 |
258 | NO WARRANTY
259 |
260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
268 | REPAIR OR CORRECTION.
269 |
270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
278 | POSSIBILITY OF SUCH DAMAGES.
279 |
280 | END OF TERMS AND CONDITIONS
281 |
282 | How to Apply These Terms to Your New Programs
283 |
284 | If you develop a new program, and you want it to be of the greatest
285 | possible use to the public, the best way to achieve this is to make it
286 | free software which everyone can redistribute and change under these terms.
287 |
288 | To do so, attach the following notices to the program. It is safest
289 | to attach them to the start of each source file to most effectively
290 | convey the exclusion of warranty; and each file should have at least
291 | the "copyright" line and a pointer to where the full notice is found.
292 |
293 |
294 | Copyright (C)
295 |
296 | This program is free software; you can redistribute it and/or modify
297 | it under the terms of the GNU General Public License as published by
298 | the Free Software Foundation; either version 2 of the License, or
299 | (at your option) any later version.
300 |
301 | This program is distributed in the hope that it will be useful,
302 | but WITHOUT ANY WARRANTY; without even the implied warranty of
303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
304 | GNU General Public License for more details.
305 |
306 | You should have received a copy of the GNU General Public License along
307 | with this program; if not, see .
308 |
309 | Also add information on how to contact you by electronic and paper mail.
310 |
311 | If the program is interactive, make it output a short notice like this
312 | when it starts in an interactive mode:
313 |
314 | Gnomovision version 69, Copyright (C) year name of author
315 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
316 | This is free software, and you are welcome to redistribute it
317 | under certain conditions; type `show c' for details.
318 |
319 | The hypothetical commands `show w' and `show c' should show the appropriate
320 | parts of the General Public License. Of course, the commands you use may
321 | be called something other than `show w' and `show c'; they could even be
322 | mouse-clicks or menu items--whatever suits your program.
323 |
324 | You should also get your employer (if you work as a programmer) or your
325 | school, if any, to sign a "copyright disclaimer" for the program, if
326 | necessary. Here is a sample; alter the names:
327 |
328 | Yoyodyne, Inc., hereby disclaims all copyright interest in the program
329 | `Gnomovision' (which makes passes at compilers) written by James Hacker.
330 |
331 | , 1 April 1989
332 | Moe Ghoul, President of Vice
333 |
334 | This General Public License does not permit incorporating your program into
335 | proprietary programs. If your program is a subroutine library, you may
336 | consider it more useful to permit linking proprietary applications with the
337 | library. If this is what you want to do, use the GNU Lesser General
338 | Public License instead of this License.
339 |
--------------------------------------------------------------------------------
/includes/class-admin-settings.php:
--------------------------------------------------------------------------------
1 | get_default_settings();
94 | update_site_option( $this->option_name, $options );
95 | update_site_option( 'aspireupdate-reset', 'true' );
96 |
97 | wp_safe_redirect(
98 | add_query_arg(
99 | [
100 | 'reset-success' => 'success',
101 | 'reset-success-nonce' => wp_create_nonce( 'aspireupdate-reset-success-nonce' ),
102 |
103 | ],
104 | network_admin_url( 'index.php?page=aspireupdate-settings' )
105 | )
106 | );
107 | ! defined( 'AP_RUN_TESTS' ) && exit;
108 | }
109 | }
110 |
111 | /**
112 | * Delete all settings.
113 | *
114 | * @return void
115 | */
116 | public function delete_all_settings() {
117 | delete_site_option( $this->option_name );
118 | }
119 |
120 | /**
121 | * Show Admin notices.
122 | *
123 | * @return void
124 | */
125 | public function admin_notices() {
126 | /**
127 | * The Admin Notice to convey a Reset Operation has happened.
128 | */
129 | if (
130 | ( 'true' === get_site_option( 'aspireupdate-reset' ) ) &&
131 | isset( $_GET['reset-success'] ) &&
132 | ( 'success' === $_GET['reset-success'] ) &&
133 | isset( $_GET['reset-success-nonce'] ) &&
134 | wp_verify_nonce( sanitize_key( $_GET['reset-success-nonce'] ), 'aspireupdate-reset-success-nonce' )
135 | ) {
136 | add_settings_error(
137 | $this->option_name,
138 | 'aspireupdate_settings_reset',
139 | esc_html__( 'Settings have been reset to default.', 'aspireupdate' ),
140 | 'success'
141 | );
142 | settings_errors( $this->option_name );
143 | delete_site_option( 'aspireupdate-reset' );
144 | }
145 |
146 | /**
147 | * The Admin Notice to convey settings have been successsfully saved.
148 | */
149 | if (
150 | isset( $_GET['settings-updated-wpnonce'] ) &&
151 | wp_verify_nonce( sanitize_key( wp_unslash( $_GET['settings-updated-wpnonce'] ) ), 'aspireupdate-settings-updated-nonce' )
152 | ) {
153 | add_settings_error(
154 | $this->option_name,
155 | 'aspireupdate_settings_saved',
156 | esc_html__( 'Settings Saved', 'aspireupdate' ),
157 | 'success'
158 | );
159 | settings_errors( $this->option_name );
160 | }
161 | }
162 |
163 | /**
164 | * Get the value of a Setting by giving priority to hard coded values.
165 | *
166 | * @param string $setting_name The name of the settings field.
167 | * @param mixed $default_value The Default value to return if the field is not defined.
168 | *
169 | * @return string The value of the settings field.
170 | */
171 | public function get_setting( $setting_name, $default_value = false ) {
172 | if ( null === $this->options ) {
173 | $options = get_site_option( $this->option_name, false );
174 | /**
175 | * If the options are not set load defaults.
176 | */
177 | if ( false === $options ) {
178 | $options = $this->get_default_settings();
179 | update_site_option( $this->option_name, $options );
180 | }
181 | $config_file_options = $this->get_settings_from_config_file();
182 | if ( is_array( $options ) ) {
183 | /**
184 | * If User Options are saved do some processing to make it match the structure of the data from the config file.
185 | */
186 | if ( isset( $options['api_host'] ) && ( 'other' === $options['api_host'] ) ) {
187 | $options['api_host'] = $options['api_host_other'];
188 | }
189 |
190 | if ( isset( $options['enable_debug_type'] ) && is_array( $options['enable_debug_type'] ) ) {
191 | $debug_types = [];
192 | foreach ( $options['enable_debug_type'] as $debug_type_name => $debug_type_enabled ) {
193 | if ( $debug_type_enabled ) {
194 | $debug_types[] = $debug_type_name;
195 | }
196 | }
197 | $options['enable_debug_type'] = $debug_types;
198 | }
199 | $this->options = wp_parse_args( $config_file_options, $options );
200 | }
201 | }
202 | return $this->options[ $setting_name ] ?? $default_value;
203 | }
204 |
205 | /**
206 | * Get the values defined in the config file.
207 | *
208 | * @return array An array of values as defined in the Config File.
209 | */
210 | private function get_settings_from_config_file() {
211 | $options = [];
212 |
213 | if ( ! defined( 'AP_ENABLE' ) ) {
214 | define( 'AP_ENABLE', false );
215 | } elseif ( AP_ENABLE ) {
216 | $options['enable'] = AP_ENABLE;
217 | }
218 |
219 | if ( ! defined( 'AP_HOST' ) ) {
220 | define( 'AP_HOST', '' );
221 | } else {
222 | $options['api_host'] = AP_HOST;
223 | }
224 |
225 | if ( ! defined( 'AP_API_KEY' ) ) {
226 | define( 'AP_API_KEY', '' );
227 | } else {
228 | $options['api_key'] = AP_API_KEY;
229 | }
230 |
231 | if ( ! defined( 'AP_DEBUG' ) ) {
232 | define( 'AP_DEBUG', false );
233 | } elseif ( AP_DEBUG ) {
234 | $options['enable_debug'] = AP_DEBUG;
235 | }
236 |
237 | if ( ! defined( 'AP_DEBUG_TYPES' ) ) {
238 | define( 'AP_DEBUG_TYPES', [] );
239 | } elseif ( is_array( AP_DEBUG_TYPES ) ) {
240 | $options['enable_debug_type'] = AP_DEBUG_TYPES;
241 | }
242 |
243 | if ( ! defined( 'AP_DISABLE_SSL' ) ) {
244 | define( 'AP_DISABLE_SSL', false );
245 | } elseif ( AP_DISABLE_SSL ) {
246 | $options['disable_ssl_verification'] = AP_DISABLE_SSL;
247 | }
248 |
249 | return $options;
250 | }
251 |
252 | /**
253 | * Update settings for single site or network activated.
254 | *
255 | * @link http://wordpress.stackexchange.com/questions/64968/settings-api-in-multisite-missing-update-message
256 | * @link http://benohead.com/wordpress-network-wide-plugin-settings/
257 | *
258 | * @return void
259 | */
260 | public function update_settings() {
261 | // Exit if improper privileges.
262 | if ( ! isset( $_POST['_wpnonce'] ) || ! wp_verify_nonce( sanitize_key( wp_unslash( $_POST['_wpnonce'] ) ), 'aspireupdate-settings' ) ) {
263 | return;
264 | }
265 |
266 | // Save settings and redirect.
267 | if ( ( isset( $_POST['option_page'], $_POST['aspireupdate_settings'] ) && 'aspireupdate_settings' === $_POST['option_page'] ) ) {
268 | update_site_option(
269 | $this->option_name,
270 | // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized -- Contents are sanitized in Admin_Settings::sanitize_settings.
271 | $this->sanitize_settings( wp_unslash( $_POST['aspireupdate_settings'] ) )
272 | );
273 |
274 | wp_safe_redirect(
275 | add_query_arg(
276 | [
277 | 'settings-updated-wpnonce' => wp_create_nonce( 'aspireupdate-settings-updated-nonce' ),
278 | ],
279 | network_admin_url( 'index.php?page=aspireupdate-settings' )
280 | )
281 | );
282 | ! defined( 'AP_RUN_TESTS' ) && exit;
283 | }
284 | }
285 |
286 | /**
287 | * Register the Admin Menu.
288 | *
289 | * @return void
290 | */
291 | public function register_admin_menu() {
292 | if ( ! defined( 'AP_REMOVE_UI' ) ) {
293 | define( 'AP_REMOVE_UI', false );
294 | }
295 | if ( false === AP_REMOVE_UI ) {
296 | add_submenu_page(
297 | 'index.php',
298 | 'AspireUpdate',
299 | 'AspireUpdate',
300 | is_multisite() ? 'manage_network_options' : 'manage_options',
301 | 'aspireupdate-settings',
302 | [ $this, 'the_settings_page' ]
303 | );
304 | }
305 | }
306 |
307 | /**
308 | * Enqueue the Scripts and Styles.
309 | *
310 | * @param string $hook The page identifier.
311 | * @return void
312 | */
313 | public function admin_enqueue_scripts( $hook ) {
314 |
315 | if ( ! in_array( $hook, [ 'dashboard_page_aspireupdate-settings', 'index_page_aspireupdate-settings' ], true ) ) {
316 |
317 | return;
318 | }
319 | wp_enqueue_style( 'aspire_update_settings_css', plugin_dir_url( __DIR__ ) . 'assets/css/aspire-update.css', [], AP_VERSION );
320 | wp_enqueue_script( 'aspire_update_settings_js', plugin_dir_url( __DIR__ ) . 'assets/js/aspire-update.js', [ 'jquery' ], AP_VERSION, true );
321 | wp_localize_script(
322 | 'aspire_update_settings_js',
323 | 'aspireupdate',
324 | [
325 | 'ajax_url' => network_admin_url( 'admin-ajax.php' ),
326 | 'nonce' => wp_create_nonce( 'aspireupdate-ajax' ),
327 | 'domain' => Utilities::get_site_domain(),
328 | 'line_ending' => PHP_EOL,
329 | 'unexpected_error' => esc_html__( 'Unexpected Error', 'aspireupdate' ),
330 | ]
331 | );
332 | }
333 |
334 | /**
335 | * The Settings Page Markup.
336 | *
337 | * @return void
338 | */
339 | public function the_settings_page() {
340 | $reset_url = add_query_arg(
341 | [
342 | 'reset' => 'reset',
343 | 'reset-nonce' => wp_create_nonce( 'aspireupdate-reset-nonce' ),
344 |
345 | ],
346 | network_admin_url( 'index.php?page=aspireupdate-settings' )
347 | );
348 | Utilities::include_file(
349 | 'page-admin-settings.php',
350 | [
351 | 'reset_url' => $reset_url,
352 | 'option_group' => $this->option_group,
353 | ]
354 | );
355 | }
356 |
357 | /**
358 | * Register all Settings.
359 | *
360 | * @return void
361 | */
362 | public function register_settings() {
363 | $nonce = wp_create_nonce( 'aspireupdate-settings' );
364 | $options = get_site_option( $this->option_name, false );
365 | /**
366 | * If the options are not set load defaults.
367 | */
368 | if ( false === $options ) {
369 | $options = $this->get_default_settings();
370 | update_site_option( $this->option_name, $options );
371 | }
372 |
373 | register_setting(
374 | $this->option_group,
375 | $this->option_name,
376 | [
377 | 'sanitize_callback' => [ $this, 'sanitize_settings' ],
378 | ]
379 | );
380 |
381 | add_settings_section(
382 | 'aspireupdate_settings_section',
383 | esc_html__( 'API Configuration', 'aspireupdate' ),
384 | null,
385 | 'aspireupdate-settings',
386 | [
387 | 'before_section' => '',
388 | 'after_section' => '
',
389 | ]
390 | );
391 |
392 | add_settings_field(
393 | 'enable',
394 | esc_html__( 'Enable AspireUpdate API Rewrites', 'aspireupdate' ),
395 | [ $this, 'add_settings_field_callback' ],
396 | 'aspireupdate-settings',
397 | 'aspireupdate_settings_section',
398 | [
399 | 'id' => 'enable',
400 | 'type' => 'checkbox',
401 | 'data' => $options,
402 | ]
403 | );
404 |
405 | add_settings_field(
406 | 'api_host',
407 | esc_html__( 'API Host', 'aspireupdate' ),
408 | [ $this, 'add_settings_field_callback' ],
409 | 'aspireupdate-settings',
410 | 'aspireupdate_settings_section',
411 | [
412 | 'id' => 'api_host',
413 | 'type' => 'hosts',
414 | 'data' => $options,
415 | 'description' => esc_html__( 'Your new API Host.', 'aspireupdate' ),
416 | 'options' => [
417 | [
418 | 'value' => 'api.aspirecloud.org',
419 | 'label' => 'AspireCloud (api.aspirecloud.org)',
420 | 'require-api-key' => 'false',
421 | 'api-key-url' => 'api.aspirecloud.org/v1/apitoken',
422 | ],
423 | [
424 | 'value' => 'other',
425 | 'label' => esc_html__( 'Other', 'aspireupdate' ),
426 | 'require-api-key' => 'false',
427 | ],
428 | ],
429 | ]
430 | );
431 |
432 | add_settings_field(
433 | 'api_key',
434 | esc_html__( 'API Key', 'aspireupdate' ),
435 | [ $this, 'add_settings_field_callback' ],
436 | 'aspireupdate-settings',
437 | 'aspireupdate_settings_section',
438 | [
439 | 'id' => 'api_key',
440 | 'type' => 'api-key',
441 | 'data' => $options,
442 | 'description' => esc_html__( 'Provides an API key for repositories that may require authentication.', 'aspireupdate' ),
443 | ]
444 | );
445 |
446 | add_settings_section(
447 | 'aspireupdate_debug_settings_section',
448 | esc_html__( 'API Debug Configuration', 'aspireupdate' ),
449 | null,
450 | 'aspireupdate-settings',
451 | [
452 | 'before_section' => '',
453 | 'after_section' => '
',
454 | ]
455 | );
456 |
457 | add_settings_field(
458 | 'enable_debug',
459 | esc_html__( 'Enable Debug Mode', 'aspireupdate' ),
460 | [ $this, 'add_settings_field_callback' ],
461 | 'aspireupdate-settings',
462 | 'aspireupdate_debug_settings_section',
463 | [
464 | 'id' => 'enable_debug',
465 | 'type' => 'checkbox',
466 | 'data' => $options,
467 | 'description' => esc_html__( 'Enables debug mode for the plugin.', 'aspireupdate' ),
468 | ]
469 | );
470 |
471 | add_settings_field(
472 | 'enable_debug_type',
473 | esc_html__( 'Enable Debug Type', 'aspireupdate' ),
474 | [ $this, 'add_settings_field_callback' ],
475 | 'aspireupdate-settings',
476 | 'aspireupdate_debug_settings_section',
477 | [
478 | 'id' => 'enable_debug_type',
479 | 'type' => 'checkbox-group',
480 | 'data' => $options,
481 | 'options' => [
482 | 'request' => esc_html__( 'Request', 'aspireupdate' ),
483 | 'response' => esc_html__( 'Response', 'aspireupdate' ),
484 | 'string' => esc_html__( 'String', 'aspireupdate' ),
485 | ],
486 | 'description' => esc_html__( 'Outputs the request URL and headers / response headers and body / string that is being rewritten.', 'aspireupdate' ),
487 | ]
488 | );
489 |
490 | add_settings_field(
491 | 'disable_ssl_verification',
492 | esc_html__( 'Disable SSL Verification', 'aspireupdate' ),
493 | [ $this, 'add_settings_field_callback' ],
494 | 'aspireupdate-settings',
495 | 'aspireupdate_debug_settings_section',
496 | [
497 | 'id' => 'disable_ssl_verification',
498 | 'type' => 'checkbox',
499 | 'data' => $options,
500 | 'class' => 'advanced-setting',
501 | 'description' => esc_html__( 'Disables the verification of SSL to allow local testing.', 'aspireupdate' ),
502 | ]
503 | );
504 | }
505 |
506 | /**
507 | * The Fields API which any CMS should have in its core but something we dont, hence this ugly hack.
508 | *
509 | * @param array $args The Field Parameters.
510 | *
511 | * @return void Echos the Field HTML.
512 | */
513 | public function add_settings_field_callback( $args = [] ) {
514 |
515 | $defaults = [
516 | 'id' => '',
517 | 'type' => 'text',
518 | 'description' => '',
519 | 'data' => [],
520 | 'options' => [],
521 | ];
522 | $args = wp_parse_args( $args, $defaults );
523 | $id = $args['id'];
524 | $type = $args['type'];
525 | $description = $args['description'];
526 | $group_options = $args['options'];
527 | $options = $args['data'];
528 |
529 | echo '';
601 | }
602 |
603 | /**
604 | * Sanitize the Inputs.
605 | *
606 | * @param array $input The Input values.
607 | * @return array The processed Input.
608 | */
609 | public function sanitize_settings( $input ) {
610 | $sanitized_input = [];
611 |
612 | $sanitized_input['enable'] = (int) ! empty( $input['enable'] );
613 | $sanitized_input['api_key'] = sanitize_text_field( $input['api_key'] ?? '' );
614 | $sanitized_input['api_host'] = sanitize_text_field( $input['api_host'] ?? '' );
615 | $sanitized_input['api_host_other'] = sanitize_text_field( $input['api_host_other'] ?? '' );
616 |
617 | $sanitized_input['enable_debug'] = (int) ! empty( $input['enable_debug'] );
618 | if ( isset( $input['enable_debug_type'] ) && is_array( $input['enable_debug_type'] ) ) {
619 | $sanitized_input['enable_debug_type'] = array_map( 'sanitize_text_field', $input['enable_debug_type'] );
620 | } else {
621 | $sanitized_input['enable_debug_type'] = [];
622 | }
623 | $sanitized_input['disable_ssl_verification'] = (int) ! empty( $input['disable_ssl_verification'] );
624 |
625 | return $sanitized_input;
626 | }
627 | }
628 |
--------------------------------------------------------------------------------