Support for new packaged extensions system.
[fa-stable.git] / admin / inst_module.php
1 <?php
2 /**********************************************************************
3     Copyright (C) FrontAccounting, LLC.
4         Released under the terms of the GNU General Public License, GPL, 
5         as published by the Free Software Foundation, either version 3 
6         of the License, or (at your option) any later version.
7     This program is distributed in the hope that it will be useful,
8     but WITHOUT ANY WARRANTY; without even the implied warranty of
9     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  
10     See the License here <http://www.gnu.org/licenses/gpl-3.0.html>.
11 ***********************************************************************/
12 $page_security = 'SA_CREATEMODULES';
13 $path_to_root="..";
14 include_once($path_to_root . "/includes/session.inc");
15 include_once($path_to_root."/includes/packages.inc");
16
17 page(_($help_context = "Install/Activate extensions"));
18
19 include_once($path_to_root . "/includes/date_functions.inc");
20 include_once($path_to_root . "/admin/db/company_db.inc");
21 include_once($path_to_root . "/admin/db/maintenance_db.inc");
22 include_once($path_to_root . "/includes/ui.inc");
23
24 simple_page_mode(true);
25 //---------------------------------------------------------------------------------------------
26 // Check third-party extension parameters
27 //
28 function check_data($id, $exts)
29 {
30         if ($_POST['name'] == "") {
31                 display_error(_("Extension name cannot be empty."));
32                 return false;
33         }
34         foreach($exts as $n =>$ext) {
35                 if ($_POST['name'] == $ext['name'] && $id != $n) {
36                         display_error(_("Extension name have to be unique."));
37                         return false;
38                 }
39         }
40
41         if ($_POST['title'] == "") {
42                 display_error(_("Extension title cannot be empty."));
43                 return false;
44         }
45         if ($_POST['path'] == "") {
46                 display_error(_("Extension folder name cannot be empty."));
47                 return false;
48         }
49         if ($id == -1 && !is_uploaded_file($_FILES['uploadfile']['tmp_name'])) {
50                 display_error(_("You have to select plugin file to upload"));
51                 return false; 
52         }
53         return true;
54 }
55
56 //---------------------------------------------------------------------------------------------
57
58 function handle_submit()
59 {
60         global $path_to_root, $db_connections, $selected_id, $next_extension_id;
61
62         $extensions = get_company_extensions();
63         if (!check_data($selected_id, $extensions))
64                 return false;
65         $id = $selected_id==-1 ? $next_extension_id : $selected_id;
66
67         if ($selected_id != -1 && $extensions[$id]['type'] != 'plugin') {
68                 display_error(_('Module installation support is not implemented.'));
69                 return;
70         }
71
72         $extensions[$id]['name'] = $_POST['name'];
73         $extensions[$id]['package'] = '';
74         $extensions[$id]['version'] = '';
75         $extensions[$id]['active'] = check_value('active');
76         $entry = $selected_id == -1 ? array() : $extensions[$id]['entries'][0];
77         
78         $entry['tab_id'] = $_POST['tab'];
79         $entry['title'] = $_POST['title'];
80         $entry['section'] = 2; // menu section aka module
81
82         // Only plugin extensions can be installed manually.
83         $extensions[$id]['type'] = 'plugin';
84         $directory = $path_to_root . "/modules/" . $_POST['path'];
85         if (!file_exists($directory))
86         {
87                 mkdir($directory);
88         }
89         if (is_uploaded_file($_FILES['uploadfile']['tmp_name']))
90         {
91                 $entry['url'] = '/modules/'.$_POST['path'].'/'.$_FILES['uploadfile']['name'];
92                 $file1 = $_FILES['uploadfile']['tmp_name'];
93                 $file2 = $directory . "/".$_FILES['uploadfile']['name'];
94                 if (file_exists($file2))
95                         unlink($file2);
96                 move_uploaded_file($file1, $file2);
97         }
98         else
99                 $entry['url'] = '/modules/'.$_POST['path'].'/'.get_post('filename');
100
101         if (is_uploaded_file($_FILES['uploadfile2']['tmp_name']))
102         {
103                 $file1 = $_FILES['uploadfile2']['tmp_name'];
104                 $db_name = $_SESSION["wa_current_user"]->company;
105                 db_import($file1, $db_connections[$db_name]);
106         }
107         
108         if (is_uploaded_file($_FILES['uploadfile3']['tmp_name']))
109         {
110                 $extensions[$id]['acc_file'] = '/modules/'.$_POST['path'].'/'.$_FILES['uploadfile3']['name'];
111                 $file1 = $_FILES['uploadfile3']['tmp_name'];
112                 $file2 = $directory . "/".$_FILES['uploadfile3']['name'];
113                 if (file_exists($file2))
114                         unlink($file2);
115                 move_uploaded_file($file1, $file2);
116         }
117         else
118                 $extensions[$id]['acc_file'] = '/modules/'.$_POST['path'].'/'.get_post('acc_file');
119
120         // security area guess for plugins
121         $exttext = file_get_contents($path_to_root.$entry['url']);
122         $area = 'SA_OPEN';
123         if (preg_match('/.*\$page_security\s*=\s*[\'"]([^\'"]*)/', $exttext, $match)) {
124                 $area = trim($match[1]);
125         }
126         $entry['access'] = $area;
127
128         $extensions[$id]['entries'] = array($entry);
129         
130         if ($selected_id == -1) 
131         {
132                 $next_extension_id++;
133         }
134         if (!update_extensions($extensions))
135                 return false;
136         return true;
137 }
138
139 function handle_delete($id)
140 {
141         global $path_to_root;
142         
143         $extensions = get_company_extensions();
144
145         if ($extensions[$id]['package'] != '') {
146                 if (!uninstall_package($extensions[$id]['package']))
147                         return false;
148         } else {
149
150                 $dirname = dirname(@$extensions[$id]['entries'][0]['url']);
151                 if ($dirname) {
152                         $dirname = $path_to_root.$dirname;
153                         flush_dir($dirname, true);
154                         rmdir($dirname);
155                 }
156         }
157         unset($extensions[$id]);
158         if (update_extensions($extensions)) {
159                 display_notification(_("Selected extension has been successfully deleted"));
160         }
161         return true;
162 }
163 //
164 // Helper for formating menu tabs/entries to be displayed in extension table
165 //
166 function fmt_titles($defs)
167 {
168                 if (!$defs) return '';
169                 foreach($defs as $def) {
170                         $str[] = access_string($def['title'], true);
171                 }
172                 return implode('<br>', array_values($str));
173 }
174 //---------------------------------------------------------------------------------------------
175 //
176 // Display list of all extensions - installed and available from repository
177 //
178 function display_extensions()
179 {
180
181         div_start('ext_tbl');
182         start_table(TABLESTYLE);
183
184         $th = array(_("Extension"),_("Modules provided"), _("Options provided"),
185                  _("Installed"), _("Available"),  "", "");
186         table_header($th);
187
188         $k = 0;
189         $mods = get_extensions_list();
190
191         foreach($mods as $pkg_name => $ext)
192         {
193                 $available = @$ext['available'];
194                 $installed = @$ext['version'];
195                 $id = @$ext['local_id'];
196                 $is_mod = $ext['type'] == 'module';
197
198                 $entries = fmt_titles(@$ext['entries']);
199                 $tabs = fmt_titles(@$ext['tabs']);
200
201                 alt_table_row_color($k);
202 //              label_cell(is_array($ext['Descr']) ? $ext['Descr'][0] : $ext['Descr']);
203                 label_cell($available ? get_package_view_str($pkg_name, $ext['name']) : $ext['name']);
204                 label_cell($tabs);
205                 label_cell($entries);
206
207                 label_cell($id === null ? _("None") :
208                         ($available && $installed ? $installed : _("Unknown")));
209                 label_cell($available ? $available : _("None"));
210
211                 if (!$available && $ext['type'] == 'plugin')    // third-party plugin
212                         button_cell('Edit'.$id, _("Edit"), _('Edit third-party extension parameters.'), 
213                                 ICON_EDIT);
214                 elseif (check_pkg_upgrade($installed, $available)) // outdated or not installed extension in repo
215                         button_cell('Update'.$pkg_name, $installed ? _("Update") : _("Install"),
216                                 _('Upload and install latest extension package'), ICON_DOWN);
217                 else
218                         label_cell('');
219
220                 if ($id !== null) {
221                         delete_button_cell('Delete'.$id, _('Delete'));
222                         submit_js_confirm('Delete'.$id, 
223                                 sprintf(_("You are about to remove package \'%s\'.\nDo you want to continue ?"), 
224                                         $ext['name']));
225                 } else
226                         label_cell('');
227
228                 end_row();
229         }
230
231         end_table(1);
232
233         submit_center_first('Refresh', _("Update"), '', null);
234         submit_center_last('Add', _("Add third-party plugin"), '', false);
235
236         div_end();
237 }
238 //---------------------------------------------------------------------------------
239 //
240 // Get all installed extensions and display
241 // with current status stored in company directory.
242 //
243 function company_extensions($id)
244 {
245         start_table(TABLESTYLE);
246         
247         $th = array(_("Extension"),_("Modules provided"), _("Options provided"), _("Active"));
248         
249         $mods = get_company_extensions();
250         $exts = get_company_extensions($id);
251         foreach($mods as $key => $ins) {
252                 foreach($exts as $ext)
253                         if ($ext['name'] == $ins['name']) {
254                                 $mods[$key]['active'] = @$ext['active'];
255                                 continue 2;
256                         }
257         }
258         $mods = array_natsort($mods, null, 'name');
259         table_header($th);
260         $k = 0;
261         foreach($mods as $i => $mod)
262         {
263                 alt_table_row_color($k);
264                 label_cell($mod['name']);
265                 $entries = fmt_titles(@$mod['entries']);
266                 $tabs = fmt_titles(@$mod['tabs']);
267                 label_cell($tabs);
268                 label_cell($entries);
269
270                 check_cells(null, 'Active'.$i, @$mod['active'] ? 1:0, 
271                         false, false, "align='center'");
272                 end_row();
273         }
274
275         end_table(1);
276         submit_center('Refresh', _('Update'), true, false, 'default');
277 }
278
279 //---------------------------------------------------------------------------------------------
280 //
281 // Third-party plugin installation
282 //
283 function display_ext_edit($selected_id)
284 {
285         global $Mode;
286
287         $extensions = get_company_extensions();
288
289         start_table(TABLESTYLE2);
290
291         if ($selected_id != -1 && $extensions[$selected_id]['type'] == 'plugin')
292         {
293                 if ($Mode == 'Edit') {
294                         $mod = $extensions[$selected_id];
295                         $entry = $mod['entries'][0];
296
297                         $_POST['name'] = $mod['name'];
298                         $_POST['tab']  = $entry['tab_id'];
299                         $_POST['title'] = $entry['title'];
300                         $_POST['path'] = substr(dirname($entry['url']), 9); //strip '/modules/'
301                         $_POST['filename'] = basename($entry['url']);
302                         $_POST['acc_file'] = @$mod['acc_file'] ? basename($mod['acc_file']) : null;
303                         hidden('filename', $_POST['filename']);
304                         hidden('acc_file', $_POST['acc_file']);
305                 }
306                 hidden('selected_id', $selected_id);
307         }
308         text_row_ex(_("Name"), 'name', 30);
309         text_row_ex(_("Folder"), 'path', 20);
310
311         tab_list_row(_("Menu Tab"), 'tab', null, true);
312         text_row_ex(_("Menu Link Text"), 'title', 30);
313
314         record_status_list_row(_("Default status"), 'active');
315
316         file_row(_("Module File"), 'uploadfile');
317         file_row(_("Access Levels Extensions"), 'uploadfile3');
318         file_row(_("SQL File"), 'uploadfile2');
319
320         end_table(0);
321         display_note(_("Select your module PHP file from your local harddisk."), 0, 1);
322         submit_add_or_update_center($selected_id == -1, '', 'both');
323 }
324
325 //---------------------------------------------------------------------------------------------
326 if ($Mode=='ADD_ITEM' || $Mode == 'UPDATE_ITEM') {
327         if(handle_submit()) {
328                 if ($selected_id != -1)
329                         display_notification(_("Extension data has been updated."));
330                 else
331                         display_notification(_("Extension has been installed."));
332         $Mode = 'RESET';
333         }
334 }
335 if ($Mode == 'Delete')
336 {
337         handle_delete($selected_id);
338         $Mode = 'RESET';
339 }
340 if (get_post('Refresh')) {
341         $exts = get_company_extensions(get_post('extset')); //
342         $comp = get_post('extset');
343         
344         foreach($exts as $i => $ext) {
345                 if ($ext['package'] && ($ext['active'] ^ check_value('Active'.$i))) {
346                         $pkg = new package($ext['package'].'-'.$ext['version'].'.pkg');
347                         $pkg->support(check_value('Active'.$i) ? 'activate':'deactivate', $comp);
348                 }
349                 $exts[$i]['active'] = check_value('Active'.$i);
350         }
351         write_extensions($exts, get_post('extset'));
352         if (get_post('extset') == user_company())
353                 $installed_extensions = $exts;
354         display_notification(_('Current active extensions set has been saved.'));
355 }
356
357 if ($id = find_submit('Update', false))
358         install_extension($id);
359
360 if ($Mode == 'RESET')
361 {
362         $selected_id = -1;
363         unset($_POST);
364 }
365
366 //---------------------------------------------------------------------------------------------
367 start_form(true);
368 if (list_updated('extset'))
369         $Ajax->activate('_page_body');
370
371 $set = get_post('extset', -1);
372
373 if (isset($_GET['popup']) || get_post('Add') || $Mode == 'Edit' 
374                 || $Mode == 'ADD_ITEM' || $Mode == 'UPDATE_ITEM') 
375 {
376         display_ext_edit($selected_id);
377 }
378 else { 
379         echo "<center>" . _('Extensions:') . "&nbsp;&nbsp;";
380         echo extset_list('extset', null, true);
381         echo "</center><br>";
382
383         if ($set == -1) 
384                 display_extensions();
385         else 
386                 company_extensions($set);
387 }
388
389 //---------------------------------------------------------------------------------------------
390 end_form();
391
392 end_page();
393 ?>