source: extensions/AMenuManager/amm_install.class.inc.php @ 9028

Revision 9028, 12.5 KB checked in by grum, 9 years ago (diff)

release 3.0.1
fix bug on config import when update from 2.x to 3.x

  • Property svn:executable set to *
Line 
1<?php
2/* -----------------------------------------------------------------------------
3  Plugin     : Advanced Menu Manager
4  Author     : Grum
5    email    : grum@piwigo.org
6    website  : http://photos.grum.fr
7    PWG user : http://forum.phpwebgallery.net/profile.php?id=3706
8
9    << May the Little SpaceFrog be with you ! >>
10  ------------------------------------------------------------------------------
11  See main.inc.php for release information
12
13  MyPolls_Install : classe to manage plugin install
14
15  --------------------------------------------------------------------------- */
16  include_once('amm_version.inc.php');
17  include_once('amm_root.class.inc.php');
18  include_once(PHPWG_PLUGINS_PATH.'GrumPluginClasses/classes/GPCTables.class.inc.php');
19
20
21  class AMM_install extends AMM_root
22  {
23    private $tablef;
24
25    public function __construct($prefixeTable, $filelocation)
26    {
27      parent::__construct($prefixeTable, $filelocation);
28      $this->tablef= new GPCTables($this->tables);
29    }
30
31    public function __destruct()
32    {
33      unset($this->tablesManager);
34      unset($this->tablef);
35      parent::__destruct();
36    }
37
38
39    /**
40     * function for installation process
41     *
42     * @return Bool : true if install process is ok, otherwise false
43     */
44    public function install()
45    {
46      $this->initConfig();
47      $this->loadConfig();
48      $this->config['installed']=AMM_VERSION2;
49      $this->config['newInstall']='y';
50      $this->saveConfig();
51
52      $tables_def=array(
53"CREATE TABLE  `".$this->tables['urls']."` (
54  `id` int(11) NOT NULL auto_increment,
55  `label` varchar(50) NOT NULL default '',
56  `url` varchar(255) NOT NULL default '',
57  `mode` int(11) NOT NULL default '0',
58  `icon` varchar(50) NOT NULL default '',
59  `position` int(11) NOT NULL default '0',
60  `visible` char(1) NOT NULL default 'y',
61  `accessUsers` varchar(1024) NOT NULL,
62  `accessGroups` varchar(1024) NOT NULL,
63  PRIMARY KEY  (`id`),
64  KEY `order_key` (`position`)
65)",
66
67"CREATE TABLE  `".$this->tables['personalised']."` (
68  `id` int(11) NOT NULL auto_increment,
69  `visible` char(1) NOT NULL default 'y',
70  `nfo` varchar(255) NOT NULL default '',
71  PRIMARY KEY  (`id`)
72)",
73
74"CREATE TABLE `".$this->tables['personalised_langs']."` (
75  `id` INTEGER UNSIGNED NOT NULL DEFAULT 0,
76  `lang` CHAR(5)  NOT NULL default '*',
77  `title` VARCHAR(255)  NOT NULL default '',
78  `content` TEXT  NOT NULL,
79  PRIMARY KEY (`id`, `lang`)
80)",
81
82"CREATE TABLE `".$this->tables['blocks']."` (
83  `id` VARCHAR(40)  NOT NULL,
84  `order` INTEGER UNSIGNED NOT NULL,
85  `users` VARCHAR(1024)  NOT NULL,
86  `groups` VARCHAR(1024)  NOT NULL,
87  PRIMARY KEY (`id`),
88  INDEX `byOrder`(`order`)
89)"
90
91);
92      //$table_def array
93      $tables_def = create_table_add_character_set($tables_def);
94      $result=$this->tablef->create($tables_def);
95      unset($tables_def);
96
97      GPCCore::register($this->getPluginName(), AMM_VERSION, AMM_GPC_NEEDED);
98
99      return($result);
100    }
101
102
103    /**
104     * function for uninstall process
105     */
106    public function uninstall()
107    {
108      $this->deleteConfig();
109      $this->tablef->drop();
110      GPCCore::unregister($this->getPluginName());
111    }
112
113    public function activate()
114    {
115      global $template;
116
117      $this->initConfig();
118      $this->loadConfig();
119
120      $this->udpateTablesDef();
121
122      $this->config['newInstall']='n';
123      $this->config['installed']=AMM_VERSION2; //update the installed release number
124      $this->saveConfig();
125
126      GPCCore::register($this->getPluginName(), AMM_VERSION, AMM_GPC_NEEDED);
127    }
128
129    public function deactivate()
130    {
131      $this->initConfig();
132      $this->loadConfig();
133      $this->restoreMenuConfig();
134    }
135
136
137    /**
138     * update tables & config between releases
139     *
140     */
141    protected function udpateTablesDef()
142    {
143      global $conf;
144
145      /* AMM release earlier than the 2.1.3 uses two parameters to manage the display
146       * of the menu items ("amm_sections_modspecials" and "amm_sections_modmenu")
147       *
148       * These two parameters are replaced by a single parameter "amm_blocks_items"
149       *
150       * This function aim to import the old conf into the new conf property
151      */
152      if(isset($this->config['amm_sections_modspecials']))
153      {
154        foreach($this->config['amm_sections_modspecials'] as $key=>$val)
155        {
156          $this->config['amm_blocks_items'][$key]['visibility']=($val=="y")?"guest,generic,normal,admin/":"admin/";
157        }
158        unset($this->config['amm_sections_modspecials']);
159      }
160
161      if(isset($this->config['amm_sections_modmenu']))
162      {
163        foreach($this->config['amm_sections_modmenu'] as $key=>$val)
164        {
165          $this->config['amm_blocks_items'][$key]['visibility']=($val=="y")?"guest,generic,normal,admin/":"admin/";
166        }
167        unset($this->config['amm_sections_modmenu']);
168      }
169
170      if(!array_key_exists('installed', $this->config))
171      {
172        /*
173         * if key does not exist, probably try to update a plugin older than the
174         * 2.2.0 release
175         */
176        $this->config['installed']="02.01.06";
177      }
178
179      switch($this->config['installed'])
180      {
181        case '02.01.06':
182          $this->config['newInstall']='n';
183          $this->updateFrom_020106();
184        case '02.02.00':
185        case '02.02.01':
186        case '02.02.02':
187        case '02.02.03':
188          $this->config['newInstall']='n';
189          $this->updateFrom_020200();
190        case '03.00.00':
191          $this->config['newInstall']='n';
192          $this->updateFrom_030000();
193        default:
194          /*
195           * default is applied for fresh install
196           */
197
198          if($this->config['installed']<='02.02.03' or
199             $this->config['newInstall']=='y')
200          {
201            /*
202             * if    new install
203             *    or plugin updated from a release <= 2.2.3
204             *    or plugin
205             *
206             * update AMM menu from piwigo's menu
207             */
208            $this->backupMenuConfig(true);
209          }
210          else
211          {
212            /*
213             * plugin actived without being installed or updated, only backup
214             * the piwigo's menu
215             */
216            $this->backupMenuConfig(false);
217          }
218          break;
219      }
220
221    }
222
223    /**
224     * update the database from the release 2.1.6
225     *
226     * - update config for menu translation
227     * - update fields length for table 'personalised'
228     */
229    private function updateFrom_020106()
230    {
231      $sql="ALTER TABLE `".$this->tables['personalised']."`
232            MODIFY COLUMN `id` INTEGER  NOT NULL AUTO_INCREMENT,
233            MODIFY COLUMN `title` VARCHAR(255) CHARACTER SET utf8 COLLATE utf8_general_ci NOT NULL,
234            MODIFY COLUMN `nfo` VARCHAR(255)  CHARACTER SET utf8 COLLATE utf8_general_ci NOT NULL;";
235      pwg_query($sql);
236
237      foreach($this->config['amm_blocks_items'] as $key => $val)
238      {
239        $this->config['amm_blocks_items'][$key]['translation'] = $this->defaultMenus[$key]['translation'];
240      }
241    }
242
243
244
245    /**
246     * update the database from the release 2.2.0
247     *
248     * - create 'personalised_lang' table ; filled from the 'personalised' table
249     *   values
250     * - modify 'personalised' table structure (remove lang attributes)
251     * - modify 'urls' table structure (add users&group access)
252     * - update 'urls' table values (default values for users access)
253     * - update config (parameter 'amm_sections_items' is renamed into 'amm_blocks_items')
254     */
255    private function updateFrom_020200()
256    {
257      global $user;
258
259      $tables_def=array(
260"CREATE TABLE `".$this->tables['personalised_langs']."` (
261  `id` INTEGER UNSIGNED NOT NULL DEFAULT 0,
262  `lang` CHAR(5)  NOT NULL default '*',
263  `title` VARCHAR(255)  NOT NULL default '',
264  `content` TEXT  NOT NULL,
265  PRIMARY KEY (`id`, `lang`)
266)",
267
268"CREATE TABLE `".$this->tables['blocks']."` (
269  `id` VARCHAR(40)  NOT NULL,
270  `order` INTEGER UNSIGNED NOT NULL,
271  `users` VARCHAR(1024)  NOT NULL,
272  `groups` VARCHAR(1024)  NOT NULL,
273  PRIMARY KEY (`id`),
274  INDEX `byOrder`(`order`)
275)"
276      );
277
278      $tables_def = create_table_add_character_set($tables_def);
279      $this->tablef->setTables(array(
280        $this->tables['personalised_langs'],
281        $this->tables['blocks'])
282      );
283      $result=$this->tablef->create($tables_def);
284
285      $sql="INSERT INTO `".$this->tables['personalised_langs']."`
286              SELECT pap.id, pap.lang, pap.title, pap.content
287              FROM `".$this->tables['personalised']."` pap
288              WHERE pap.title!='' OR pap.content!='';";
289      pwg_query($sql);
290
291
292      if(!isset($user['language']) or $user['language']=='')
293      {
294        $sql="SELECT language FROM ".USER_INFOS_TABLE." WHERE user_id='1';";
295        $result=pwg_query($sql);
296        if($result)
297        {
298          while($row=pwg_db_fetch_assoc($result))
299          {
300            $user['language']=$row['language'];
301          }
302        }
303      }
304      $sql="DELETE FROM `".$this->tables['personalised']."` WHERE lang!='".$user['language']."';";
305      pwg_query($sql);
306
307      $sql="ALTER TABLE `".$this->tables['personalised']."` DROP COLUMN `lang`,
308             DROP COLUMN `title`,
309             DROP COLUMN `content`;";
310      pwg_query($sql);
311
312      $sql="ALTER TABLE `".$this->tables['urls']."`
313            ADD COLUMN `accessUsers` VARCHAR(1024)  NOT NULL AFTER `visible`,
314            ADD COLUMN `accessGroups` VARCHAR(1024)  NOT NULL AFTER `accessUsers`;";
315      pwg_query($sql);
316
317      if(isset($this->config['amm_sections_items']))
318      {
319        $this->config['amm_blocks_items']=$this->config['amm_sections_items'];
320        unset($this->config['amm_sections_items']);
321      }
322
323
324      $usersList=array('guest', 'generic', 'normal', 'webmaster', 'admin');
325      foreach($this->config['amm_blocks_items'] as $key => $item)
326      {
327        $tmp0=explode('/', $item['visibility']);
328        $this->config['amm_blocks_items'][$key]['visibility']=implode(',', array_diff($usersList, explode(',', $tmp0[0]))).'/'.$tmp0[1];
329      }
330    }
331
332
333
334    /**
335     * update the database from the release 3.0.0
336     *
337     * - add auto increment on personnalised_lang table
338     */
339    private function updateFrom_030000()
340    {
341      global $user;
342
343      $sql="ALTER TABLE `".$this->tables['personalised']."` MODIFY COLUMN `id` INTEGER  NOT NULL AUTO_INCREMENT;";
344      pwg_query($sql);
345    }
346
347
348
349
350    /**
351     * report hidden menu from piwigo's config to AMM config
352     */
353    private function backupMenuConfig($updateMenu=false)
354    {
355      global $conf;
356
357      $this->config['amm_old_blk_menubar']=$conf['blk_menubar'];
358      pwg_query("UPDATE ".CONFIG_TABLE." SET value = '' WHERE param='blk_menubar';");
359
360      if($updateMenu and $conf['blk_menubar']!='')
361      {
362        $tmp=unserialize($conf['blk_menubar']);
363        foreach($tmp as $key => $val)
364        {
365          pwg_query("REPLACE INTO ".$this->tables['blocks']." VALUES ('$key', '".abs($val)."', '".($val<0?'guest,generic,normal,webmaster,admin':'')."', '');");
366        }
367      }
368    }
369
370    /**
371     * restore piwigo's menu
372     */
373    private function restoreMenuConfig()
374    {
375      if($this->config['amm_old_blk_menubar']!='')
376        pwg_query("UPDATE ".CONFIG_TABLE." SET value = '".pwg_db_real_escape_string($this->config['amm_old_blk_menubar'])."' WHERE param='blk_menubar';");
377    }
378
379  } //class
380
381
382  if(!function_exists('create_table_add_character_set') and !defined('IN_ADMIN'))
383  {
384    /**
385     * from admin/include/functions.php
386     *
387     * adds the caracter set to a create table sql query.
388     * all CREATE TABLE queries must call this function
389     * @param string query - the sql query
390     */
391    function create_table_add_character_set($query)
392    {
393      defined('DB_CHARSET') or fatal_error('create_table_add_character_set DB_CHARSET undefined');
394      if ('DB_CHARSET'!='')
395      {
396        if ( version_compare(mysql_get_server_info(), '4.1.0', '<') )
397        {
398          return $query;
399        }
400        $charset_collate = " DEFAULT CHARACTER SET ".DB_CHARSET;
401        if (DB_COLLATE!='')
402        {
403          $charset_collate .= " COLLATE ".DB_COLLATE;
404        }
405        if ( is_array($query) )
406        {
407          foreach( $query as $id=>$q)
408          {
409            $q=trim($q);
410            $q=trim($q, ';');
411            if (preg_match('/^CREATE\s+TABLE/i',$q))
412            {
413              $q.=$charset_collate;
414            }
415            $q .= ';';
416            $query[$id] = $q;
417          }
418        }
419        else
420        {
421          $query=trim($query);
422          $query=trim($query, ';');
423          if (preg_match('/^CREATE\s+TABLE/i',$query))
424          {
425            $query.=$charset_collate;
426          }
427          $query .= ';';
428        }
429      }
430      return $query;
431    }
432  }
433
434
435?>
Note: See TracBrowser for help on using the repository browser.