plugins/new_user_dialog/new_user_dialog.php

   1 <?php
   2
   3 /**
   4  * Present identities settings dialog to new users
   5  *
   6  * When a new user is created, this plugin checks the default identity
   7  * and sets a session flag in case it is incomplete. An overlay box will appear
   8  * on the screen until the user has reviewed/completed his identity.
   9  *
  10  * @version @package_version@
  11  * @author Thomas Bruederli
  12  */
  13 class new_user_dialog extends rcube_plugin
  14 {
  15   public $task = 'login|mail';
  16
  17   function init()
  18   {
  19     $this->add_hook('identity_create', array($this, 'create_identity'));
  20     $this->register_action('plugin.newusersave', array($this, 'save_data'));
  21
  22     // register additional hooks if session flag is set
  23     if ($_SESSION['plugin.newuserdialog']) {
  24       $this->add_hook('render_page', array($this, 'render_page'));
  25     }
  26   }
  27
  28   /**
  29    * Check newly created identity at first login
  30    */
  31   function create_identity($p)
  32   {
  33     // set session flag when a new user was created and the default identity seems to be incomplete
  34     if ($p['login'] && !$p['complete'])
  35       $_SESSION['plugin.newuserdialog'] = true;
  36   }
  37
  38   /**
  39    * Callback function when HTML page is rendered
  40    * We'll add an overlay box here.
  41    */
  42   function render_page($p)
  43   {
  44     if ($_SESSION['plugin.newuserdialog'] && $p['template'] == 'mail') {
  45       $this->add_texts('localization');
  46
  47       $rcmail = rcmail::get_instance();
  48       $identity = $rcmail->user->get_identity();
  49       $identities_level = intval($rcmail->config->get('identities_level', 0));
  50
  51       // compose user-identity dialog
  52       $table = new html_table(array('cols' => 2));
  53
  54       $table->add('title', $this->gettext('name'));
  55       $table->add(null, html::tag('input', array(
  56         'type' => 'text',
  57         'name' => '_name',
  58         'value' => $identity['name']
  59       )));
  60
  61       $table->add('title', $this->gettext('email'));
  62       $table->add(null, html::tag('input', array(
  63         'type' => 'text',
  64         'name' => '_email',
  65         'value' => rcube_idn_to_utf8($identity['email']),
  66         'disabled' => ($identities_level == 1 || $identities_level == 3)
  67       )));
  68
  69       // add overlay input box to html page
  70       $rcmail->output->add_footer(html::div(array('id' => 'newuseroverlay'),
  71         html::tag('form', array(
  72             'action' => $rcmail->url('plugin.newusersave'),
  73             'method' => 'post'),
  74           html::tag('h3', null, Q($this->gettext('identitydialogtitle'))) .
  75           html::p('hint', Q($this->gettext('identitydialoghint'))) .
  76           $table->show() .
  77           html::p(array('class' => 'formbuttons'),
  78             html::tag('input', array('type' => 'submit',
  79               'class' => 'button mainaction', 'value' => $this->gettext('save'))))
  80         )
  81       ));
  82
  83       // disable keyboard events for messages list (#1486726)
  84       $rcmail->output->add_script(
  85         "$(document).ready(function () {
  86           rcmail.message_list.key_press = function(){};
  87           rcmail.message_list.key_down = function(){};
  88           $('input[name=_name]').focus();
  89           });", 'foot');
  90
  91       $this->include_stylesheet('newuserdialog.css');
  92     }
  93   }
  94
  95   /**
  96    * Handler for submitted form
  97    *
  98    * Check fields and save to default identity if valid.
  99    * Afterwards the session flag is removed and we're done.
 100    */
 101   function save_data()
 102   {
 103     $rcmail = rcmail::get_instance();
 104     $identity = $rcmail->user->get_identity();
 105     $identities_level = intval($rcmail->config->get('identities_level', 0));
 106
 107     $save_data = array(
 108       'name' => get_input_value('_name', RCUBE_INPUT_POST),
 109       'email' => get_input_value('_email', RCUBE_INPUT_POST),
 110     );
 111
 112     // don't let the user alter the e-mail address if disabled by config
 113     if ($identities_level == 1 || $identities_level == 3)
 114       $save_data['email'] = $identity['email'];
 115     else
 116       $save_data['email'] = rcube_idn_to_ascii($save_data['email']);
 117
 118     // save data if not empty
 119     if (!empty($save_data['name']) && !empty($save_data['email'])) {
 120       $rcmail->user->update_identity($identity['identity_id'], $save_data);
 121       $rcmail->session->remove('plugin.newuserdialog');
 122     }
 123
 124     $rcmail->output->redirect('');
 125   }
 126
 127 }
 128
 129 ?>