dolibarr  17.0.4
modWebsite.class.php
Go to the documentation of this file.
1 <?php
2 /* Copyright (C) 2015 Laurent Destailleur <eldy@users.sourceforge.net>
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation; either version 3 of the License, or
7  * (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program. If not, see <https://www.gnu.org/licenses/>.
16  */
17 
25 include_once DOL_DOCUMENT_ROOT.'/core/modules/DolibarrModules.class.php';
26 
27 
32 {
33 
39  public function __construct($db)
40  {
41  global $langs, $conf;
42 
43  $this->db = $db;
44  $this->numero = 10000;
45 
46  // Family can be 'crm','financial','hr','projects','products','ecm','technic','other'
47  // It is used to group modules in module setup page
48  $this->family = "portal";
49  $this->module_position = '50';
50  // Module label (no space allowed), used if translation string 'ModuleXXXName' not found (where XXX is value of numeric property 'numero' of module)
51  $this->name = preg_replace('/^mod/i', '', get_class($this));
52  $this->description = "Enable to build and serve public web sites with CMS features";
53  // Possible values for version are: 'development', 'experimental', 'dolibarr' or version
54  $this->version = 'dolibarr';
55  // Key used in llx_const table to save module status enabled/disabled (where MYMODULE is value of property name of module in uppercase)
56  $this->const_name = 'MAIN_MODULE_'.strtoupper($this->name);
57  // Name of image file used for this module.
58  $this->picto = 'website';
59 
60  // Data directories to create when module is enabled
61  $this->dirs = array("/website/temp");
62 
63  // Config pages
64  $this->config_page_url = array('website.php');
65 
66  // Dependencies
67  $this->hidden = !empty($conf->global->MODULE_WEBSITE_DISABLED); // A condition to disable module
68  $this->depends = array('modFckeditor'); // List of modules id that must be enabled if this module is enabled
69  $this->requiredby = array(); // List of modules id to disable if this one is disabled
70  $this->conflictwith = array(); // List of modules id this module is in conflict with
71  $this->phpmin = array(7, 0); // Minimum version of PHP required by module
72  $this->langfiles = array("website");
73 
74  // Constants
75  $this->const = array();
76 
77  // New pages on tabs
78  //$this->tabs[] = array(); // To add a new tab identified by code tabname1
79 
80  // Boxes
81  $this->boxes = array();
82 
83  // Permissions
84  $this->rights = array(); // Permission array used by this module
85  $this->rights_class = 'website';
86  $r = 0;
87 
88  $this->rights[$r][0] = 10001;
89  $this->rights[$r][1] = 'Read website content';
90  $this->rights[$r][3] = 0;
91  $this->rights[$r][4] = 'read';
92  $r++;
93 
94  $this->rights[$r][0] = 10002;
95  $this->rights[$r][1] = 'Create/modify website content (html and javascript content)';
96  $this->rights[$r][3] = 0;
97  $this->rights[$r][4] = 'write';
98  $r++;
99 
100  $this->rights[$r][0] = 10003;
101  $this->rights[$r][1] = 'Create/modify website content (dynamic php code). Dangerous, must be reserved to restricted developers.';
102  $this->rights[$r][3] = 0;
103  $this->rights[$r][4] = 'writephp';
104  $r++;
105 
106  $this->rights[$r][0] = 10005;
107  $this->rights[$r][1] = 'Delete website content';
108  $this->rights[$r][3] = 0;
109  $this->rights[$r][4] = 'delete';
110  $r++;
111 
112  $this->rights[$r][0] = 10008;
113  $this->rights[$r][1] = 'Export website content';
114  $this->rights[$r][3] = 0;
115  $this->rights[$r][4] = 'export';
116  $r++;
117 
118  // Main menu entries
119  $r = 0;
120  $this->menu[$r] = array('fk_menu'=>'0', // Use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode
121  'type'=>'top', // This is a Left menu entry
122  'titre'=>'WebSites',
123  'prefix' => img_picto('', $this->picto, 'class="paddingright pictofixedwidth em092"'),
124  'mainmenu'=>'website',
125  'url'=>'/website/index.php',
126  'langs'=>'website', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
127  'position'=>100,
128  'enabled'=>'$conf->website->enabled', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled. Use '$leftmenu==\'system\'' to show if leftmenu system is selected.
129  'perms'=>'$user->rights->website->read', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
130  'target'=>'',
131  'user'=>2); // 0=Menu for internal users, 1=external users, 2=both
132  $r++;
133 
134  // Exports
135  $r = 1;
136 
137  $this->export_code[$r] = $this->rights_class.'_'.$r;
138  $this->export_label[$r] = 'MyWebsitePages'; // Translation key (used only if key ExportDataset_xxx_z not found)
139  $this->export_permission[$r] = array(array("website", "export"));
140  $this->export_icon[$r] = 'globe';
141  $keyforclass = 'WebsitePage';
142  $keyforclassfile = '/website/class/websitepage.class.php';
143  $keyforelement = 'Website';
144  include DOL_DOCUMENT_ROOT.'/core/commonfieldsinexport.inc.php';
145  //$keyforselect='myobject'; $keyforelement='myobject'; $keyforaliasextra='extra';
146  //include DOL_DOCUMENT_ROOT.'/core/extrafieldsinexport.inc.php';
147  $this->export_sql_start[$r] = 'SELECT DISTINCT ';
148  $this->export_sql_end[$r] = ' FROM '.MAIN_DB_PREFIX.'website_page as t, '.MAIN_DB_PREFIX.'website as p';
149  $this->export_sql_end[$r] .= ' WHERE t.fk_website = p.rowid';
150  $this->export_sql_end[$r] .= ' AND p.entity IN ('.getEntity('website').')';
151  $r++;
152  }
153 
154 
163  public function init($options = '')
164  {
165  global $conf, $langs;
166 
167  $error = 0;
168 
169  $result = $this->_load_tables('/install/mysql/', 'website');
170  if ($result < 0) {
171  return -1; // Do not activate module if error 'not allowed' returned when loading module SQL queries (the _load_table run sql with run_sql with the error allowed parameter set to 'default')
172  }
173 
174  // Remove permissions and default values
175  $this->remove($options);
176 
177  // Copy flags and octicons directory
178  $dirarray = array('common/flags'=>'flags', 'common/octicons/build/svg'=>'octicons');
179  foreach ($dirarray as $dirfrom => $dirtarget) {
180  $src = DOL_DOCUMENT_ROOT.'/theme/'.$dirfrom;
181  $dest = DOL_DATA_ROOT.'/medias/image/'.$dirtarget;
182 
183  if (is_dir($src)) {
184  require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
185  dol_mkdir($dest);
186  $result = dolCopyDir($src, $dest, 0, 0);
187  if ($result < 0) {
188  $langs->load("errors");
189  $this->error = $langs->trans('ErrorFailToCopyDir', $src, $dest);
190  $this->errors[] = $langs->trans('ErrorFailToCopyDir', $src, $dest);
191  $error++;
192  }
193  }
194  }
195 
196  if ($error) {
197  return 0;
198  }
199 
200  // Website templates
201  $srcroot = DOL_DOCUMENT_ROOT.'/install/doctemplates/websites';
202  $destroot = DOL_DATA_ROOT.'/doctemplates/websites';
203 
204  dol_mkdir($destroot);
205 
206  // Copy templates in zip format (old)
207  $docs = dol_dir_list($srcroot, 'files', 0, 'website_.*(\.zip|\.jpg)$');
208  foreach ($docs as $cursorfile) {
209  $src = $srcroot.'/'.$cursorfile['name'];
210  $dest = $destroot.'/'.$cursorfile['name'];
211 
212  $result = dol_copy($src, $dest, 0, 1); // For full zip templates, we overwrite old existing files
213  if ($result < 0) {
214  $langs->load("errors");
215  $this->error = $langs->trans('ErrorFailToCopyFile', $src, $dest);
216  $this->errors[] = $langs->trans('ErrorFailToCopyFile', $src, $dest);
217  $error++;
218  }
219  }
220 
221  // Copy templates in dir format (recommended)
222  $docs = dol_dir_list($srcroot, 'directories', 0, 'website_.*$');
223 
224  foreach ($docs as $cursorfile) {
225  $src = $srcroot.'/'.$cursorfile['name'];
226  $dest = $destroot.'/'.$cursorfile['name'];
227 
228  // Compress it
229  global $errormsg;
230  $errormsg = '';
231  $result = dol_compress_dir($src, $dest.'.zip', 'zip');
232  if ($result < 0) {
233  $error++;
234  $this->error = ($errormsg ? $errormsg : $langs->trans('ErrorFailToCreateZip', $dest));
235  $this->errors[] = ($errormsg ? $errormsg : $langs->trans('ErrorFailToCreateZip', $dest));
236  }
237  }
238 
239  if ($error) {
240  return 0;
241  }
242 
243  $sql = array();
244 
245  return $this->_init($sql, $options);
246  }
247 }
Class DolibarrModules.
_init($array_sql, $options='')
Enables a module.
_load_tables($reldir, $onlywithsuffix='')
Create tables and keys required by module:
Class to describe Websites module.
__construct($db)
Constructor.
init($options='')
Function called when module is enabled.
print *****$script_file(".$version.") pid cd cd cd description as description
Only used if Module[ID]Desc translation string is not found.
dol_copy($srcfile, $destfile, $newmask=0, $overwriteifexists=1)
Copy a file to another file.
Definition: files.lib.php:713
dol_dir_list($path, $types="all", $recursive=0, $filter="", $excludefilter=null, $sortcriteria="name", $sortorder=SORT_ASC, $mode=0, $nohook=0, $relativename="", $donotfollowsymlinks=0, $nbsecondsold=0)
Scan a directory and return a list of files/directories.
Definition: files.lib.php:61
dolCopyDir($srcfile, $destfile, $newmask, $overwriteifexists, $arrayreplacement=null, $excludesubdir=0, $excludefileext=null)
Copy a dir to another dir.
Definition: files.lib.php:773
img_picto($titlealt, $picto, $moreatt='', $pictoisfullpath=false, $srconly=0, $notitle=0, $alt='', $morecss='', $marginleftonlyshort=2)
Show picto whatever it's its name (generic function)
dol_mkdir($dir, $dataroot='', $newmask='')
Creation of a directory (this can create recursive subdir)
$conf db name
Only used if Module[ID]Name translation string is not found.
Definition: repair.php:122
$conf db
API class for accounts.
Definition: inc.php:41