Changeset 27697

Timestamp:

Mar 11, 2014, 11:25:49 PM (10 years ago)

Author:

plg

Message:

compatibility with Piwigo 2.6 new user manager

relies on a new trigger ws_users_getList (for Piwigo 2.6.2)

Replace table piwigo_user_notes by column piwigo_user_infos.usernotes (simpler
coding for the plugin and automatic management of column in user manager table)

Location:

extensions/AddUsersNotes

Files:

• initadmin.php (deleted)
• main.inc.php (modified) (1 diff)
• maintain.inc.php (modified) (1 diff)
• profile_addusersnotes.tpl (deleted)

extensions/AddUsersNotes/main.inc.php

@@ -13 +13 @@
 global $prefixeTable;
 
-define('USERNOTES_DIR' , basename(dirname(__FILE__)));
-define('USERNOTES_PATH' , PHPWG_PLUGINS_PATH . USERNOTES_DIR . '/');
-define('USERNOTES_TABLE' , $prefixeTable . 'user_notes');
+// +-----------------------------------------------------------------------+
+// | Define plugin constants                                               |
+// +-----------------------------------------------------------------------+
 
-  // Plugin for admin
-if (script_basename() == 'admin')   
+define('USERNOTES_ID', basename(dirname(__FILE__)));
+define('USERNOTES_PATH', PHPWG_PLUGINS_PATH.USERNOTES_ID.'/');
+define('USERNOTES_VERSION', 'auto');
+
+// init the plugin
+add_event_handler('init', 'usernotes_init');
+
+/**
+ * plugin initialization
+ *   - check for upgrades
+ *   - load language
+ */
+function usernotes_init()
 {
-  include_once(dirname(__FILE__).'/initadmin.php');
+  // apply upgrade if needed
+  include_once(USERNOTES_PATH.'maintain.inc.php');
+  $maintain = new AddUsersNotes_maintain(USERNOTES_ID);
+  $maintain->autoUpdate(USERNOTES_VERSION, 'install');
+  
+  // load plugin language file
+  load_language('plugin.lang', USERNOTES_PATH);
 }
 
+add_event_handler('loc_begin_admin_page', 'usernotes_add_column');
+function usernotes_add_column()
+{
+  global $template;
+  
+        $template->set_prefilter('user_list', 'usernotes_add_column_prefilter');
+}
+
+function usernotes_add_column_prefilter($content, &$smarty)
+{
+  // add the "Notes" column in the user table
+  $search = '<th>{\'registration date\'|@translate}</th>';
+  $content = str_replace($search, $search.'<th>{\'Notes\'|@translate}</th>', $content);
+
+  // add the "Notes" field in user profile form
+  $search = '#</div>\s*<div class="userPropertiesSet userPrefs">#ms';
+  $replace = '<div class="userProperty"><strong>{\'Notes\'|translate}</strong><br><input type="text" name="usernotes" value="<%- user.usernotes %>" style="width:338px;"></div></div><div class="userPropertiesSet userPrefs">';
+  $content = preg_replace($search, $replace, $content);
+
+  return $content;
+}
+
+add_event_handler('user_list_columns', 'usernotes_user_list_columns', EVENT_HANDLER_PRIORITY_NEUTRAL, 1);
+function usernotes_user_list_columns($aColumns)
+{
+  $aColumns[] = 'usernotes';
+  
+  return $aColumns;
+}
+
+add_event_handler('ws_invoke_allowed', 'usernotes_ws_users_setInfo', EVENT_HANDLER_PRIORITY_NEUTRAL, 3);
+function usernotes_ws_users_setInfo($res, $methodName, $params)
+{
+  if ($methodName != 'pwg.users.setInfo')
+  {
+    return $res;
+  }
+
+  if (!isset($_POST['usernotes']))
+  {
+    return $res;
+  }
+  
+  if (count($params['user_id']) == 0)
+  {
+    return $res;
+  }
+  
+  $updates = array();
+
+  foreach ($params['user_id'] as $user_id)
+  {
+    $updates[] = array(
+      'user_id' => $user_id,
+      'usernotes' => $_POST['usernotes'],
+      );
+  }
+  
+  if (count($updates) > 0)
+  {
+    mass_updates(
+      USER_INFOS_TABLE,
+      array(
+        'primary' => array('user_id'),
+        'update'  => array('usernotes')
+        ),
+      $updates
+      );
+  }
+  
+  return $res;
+}
+
+add_event_handler('ws_users_getList', 'usernotes_ws_users_getList', EVENT_HANDLER_PRIORITY_NEUTRAL, 1);
+function usernotes_ws_users_getList($users)
+{
+  $user_ids = array();
+  foreach ($users as $user_id => $user)
+  {
+    $user_ids[] = $user_id;
+  }
+
+  if (count($user_ids) == 0)
+  {
+    return $users;
+  }
+  
+  $query = '
+SELECT
+    user_id,
+    usernotes
+  FROM '.USER_INFOS_TABLE.'
+  WHERE user_id IN ('.implode(',', $user_ids).')
+;';
+  $result = pwg_query($query);
+  while ($row = pwg_db_fetch_assoc($result))
+  {
+    $users[$row['user_id']]['usernotes'] = $row['usernotes'];
+  }
+
+  return $users;
+}
 ?>

extensions/AddUsersNotes/maintain.inc.php

@@ -1 +1 @@
 <?php
-
 if (!defined('PHPWG_ROOT_PATH')) die('Hacking attempt!');
 
-function plugin_install()
+class AddUsersNotes_maintain extends PluginMaintain
 {
+  private $installed = false;
+
+  function __construct($plugin_id)
+  {
+    parent::__construct($plugin_id);
+  }
+
+  function install($plugin_version, &$errors=array())
+  {
     global $prefixeTable;
+    
+    // add a new column to existing table
+    $result = pwg_query('SHOW COLUMNS FROM `'.USER_INFOS_TABLE.'` LIKE "usernotes";');
+    if (!pwg_db_num_rows($result))
+    {
+      pwg_query('ALTER TABLE `' . USER_INFOS_TABLE . '` ADD `usernotes` VARCHAR(255) DEFAULT NULL;');
+    }
 
-if (!defined('USERNOTES_TABLE')) define('USERNOTES_TABLE', $prefixeTable.'user_notes');
-        $query = "CREATE TABLE IF NOT EXISTS ". USERNOTES_TABLE ." (
-user_id SMALLINT( 5 ) UNSIGNED NOT NULL ,
-note VARCHAR( 255 ) NOT NULL ,
-PRIMARY KEY (user_id))DEFAULT CHARSET=utf8;";
-        $result = pwg_query($query);
-        
+    // if we find the old table, we copy notes
+    $result = pwg_query('SHOW TABLES LIKE "'.$prefixeTable.'user_notes";');
+    if (pwg_db_num_rows($result))
+    {
+      $query = '
+UPDATE
+    '.USER_INFOS_TABLE.' AS ui,
+    '.$prefixeTable.'user_notes AS un
+  SET ui.usernotes = un.note
+  WHERE ui.user_id = un.user_id
+    AND LENGTH(note) > 0
+;';
+      pwg_query($query);
+
+      pwg_query('DROP TABLE '.$prefixeTable.'user_notes;');
+    }
+    
+    $this->installed = true;
+  }
+
+  function activate($plugin_version, &$errors=array())
+  {
+    if (!$this->installed)
+    {
+      $this->install($plugin_version, $errors);
+    }
+  }
+
+  function deactivate()
+  {
+  }
+
+  function uninstall()
+  {
+    pwg_query('ALTER TABLE `'. USER_INFOS_TABLE .'` DROP `usernotes`;');
+  }
 }
-
-function plugin_uninstall()
-{
-        global $prefixeTable;
-
-        $q = 'DROP TABLE ' . $prefixeTable . 'user_notes;';
-    pwg_query($q);
-}
-
-
 ?>