- Deprecate $DB, $USER, $IMAP global variables, Use $RCMAIL instead

CHANGELOG

@@ -1,6 +1,7 @@
 CHANGELOG Roundcube Webmail
 ===========================
 
+- Deprecate $DB, $USER, $IMAP global variables, Use $RCMAIL instead
 - Add option to set default font for HTML message (#1484137)
 - Fix issues with big memory allocation of IMAP results
 - Replace prompt() with jQuery UI dialog (#1485135)

bin/msgexport.sh

@@ -30,12 +30,12 @@ function progress_update($pos, $max)
 function export_mailbox($mbox, $filename)
 {
 	global $IMAP;
-	
+
 	$IMAP->set_mailbox($mbox);
-	
+
 	vputs("Getting message list of {$mbox}...");
 	vputs($IMAP->messagecount()." messages\n");
-	
+
 	if ($filename)
 	{
 		if (!($out = fopen($filename, 'w')))
@@ -47,7 +47,7 @@ function export_mailbox($mbox, $filename)
 	}
 	else
 		$out = STDOUT;
-	
+
 	for ($count = $IMAP->messagecount(), $i=1; $i <= $count; $i++)
 	{
 		$headers = $IMAP->get_headers($i, null, false);

program/include/rcmail.php

@@ -159,8 +159,6 @@ class rcmail
   /**
    * Initial startup function
    * to register session, create database and imap connections
-   *
-   * @todo Remove global vars $DB, $USER
    */
   private function startup()
   {
@@ -172,7 +170,10 @@ class rcmail
     }
 
     // connect to database
-    $GLOBALS['DB'] = $this->get_dbh();
+    $this->get_dbh();
+
+    // set global object for backward compatibility
+    $GLOBALS['DB'] = $this->db;
 
     // start session
     $this->session_init();
@@ -240,6 +241,8 @@ class rcmail
   {
     if (is_object($user)) {
       $this->user = $user;
+
+      // set global object for backward compatibility
       $GLOBALS['USER'] = $this->user;
 
       // overwrite config with user preferences
@@ -320,8 +323,8 @@ class rcmail
 
     return $this->db;
   }
-  
-  
+
+
   /**
    * Get global handle for memcache access
    *

program/steps/mail/compose.inc

@@ -245,7 +245,7 @@ if (!empty($msg_uid))
 $MESSAGE->compose = array();
 
 // get user's identities
-$MESSAGE->identities = $USER->list_identities();
+$MESSAGE->identities = $RCMAIL->user->list_identities();
 if (count($MESSAGE->identities))
 {
   foreach ($MESSAGE->identities as $idx => $ident) {

program/steps/mail/sendmail.inc

@@ -72,9 +72,9 @@ function rcmail_encrypt_header($what)
 // get identity record
 function rcmail_get_identity($id)
 {
-  global $USER, $OUTPUT;
+  global $RCMAIL, $OUTPUT;
 
-  if ($sql_arr = $USER->get_identity($id)) {
+  if ($sql_arr = $RCMAIL->user->get_identity($id)) {
     $out = $sql_arr;
     $out['mailto'] = $sql_arr['email'];
     $out['string'] = format_email_recipient($sql_arr['email'],

program/steps/settings/delete_identity.inc

@@ -32,7 +32,7 @@ if ($iid && preg_match('/^[0-9]+(,[0-9]+)*$/', $iid))
 {
   $plugin = $RCMAIL->plugins->exec_hook('identity_delete', array('id' => $iid));
   
-  $deleted = !$plugin['abort'] ? $USER->delete_identity($iid) : $plugin['result'];
+  $deleted = !$plugin['abort'] ? $RCMAIL->user->delete_identity($iid) : $plugin['result'];
 
   if ($deleted > 0 && $deleted !== false)
     $OUTPUT->show_message('deletedsuccessfully', 'confirmation', null, false);

program/steps/settings/edit_identity.inc

@@ -23,7 +23,7 @@ define('IDENTITIES_LEVEL', intval($RCMAIL->config->get('identities_level', 0)));
 
 // edit-identity
 if (($_GET['_iid'] || $_POST['_iid']) && $RCMAIL->action=='edit-identity') {
-  $IDENTITY_RECORD = $USER->get_identity(get_input_value('_iid', RCUBE_INPUT_GPC));
+  $IDENTITY_RECORD = $RCMAIL->user->get_identity(get_input_value('_iid', RCUBE_INPUT_GPC));
 
   if (is_array($IDENTITY_RECORD))
     $OUTPUT->set_env('iid', $IDENTITY_RECORD['identity_id']);

program/steps/settings/func.inc

@@ -63,14 +63,14 @@ function rcmail_sections_list($attrib)
 
 function rcmail_identities_list($attrib)
 {
-  global $OUTPUT, $USER, $RCMAIL;
+  global $OUTPUT, $RCMAIL;
 
   // add id to message list table if not specified
   if (!strlen($attrib['id']))
     $attrib['id'] = 'rcmIdentitiesList';
 
   // get identities list and define 'mail' column
-  $list = $USER->list_identities();
+  $list = $RCMAIL->user->list_identities();
   foreach ($list as $idx => $row)
     $list[$idx]['mail'] = trim($row['name'] . ' <' . rcube_idn_to_utf8($row['email']) .'>');
 

program/steps/settings/save_identity.inc

@@ -84,7 +84,7 @@ if ($_POST['_iid'])
     $save_data['reply-to'] = rcube_idn_to_ascii($save_data['reply-to']);
 
   if (!$plugin['abort'])
-    $updated = $USER->update_identity($iid, $save_data);
+    $updated = $RCMAIL->user->update_identity($iid, $save_data);
   else
     $updated = $plugin['result'];
 
@@ -124,7 +124,7 @@ else if (IDENTITIES_LEVEL < 2)
     $save_data['reply-to'] = rcube_idn_to_ascii($save_data['reply-to']);
 
   if (!$plugin['abort'])
-    $insert_id = $save_data['email'] ? $USER->insert_identity($save_data) : null;
+    $insert_id = $save_data['email'] ? $RCMAIL->user->insert_identity($save_data) : null;
   else
     $insert_id = $plugin['result'];
 
@@ -149,7 +149,7 @@ else
 
 // mark all other identities as 'not-default'
 if ($default_id)
-  $USER->set_default($default_id);
+  $RCMAIL->user->set_default($default_id);
 
 // go to next step
 rcmail_overwrite_action('identities');

program/steps/settings/save_prefs.inc

@@ -188,7 +188,7 @@ switch ($CURR_SECTION)
 
 // Save preferences
 if (!$plugin['abort'])
-  $saved = $USER->save_prefs($a_user_prefs);
+  $saved = $RCMAIL->user->save_prefs($a_user_prefs);
 else
   $saved = $plugin['result'];