rc1: plugins/enigma/enigma.php comparison

comparison plugins/enigma/enigma.php @ 0:1e000243b222

vanilla 1.3.3 distro, I hope

author	Charlie Root
date	Thu, 04 Jan 2018 15:50:29 -0500
parents
children

comparison

equal deleted inserted replaced

--1:000000000000
+:1e000243b222
+<?php
+/**
++-------------------------------------------------------------------------+
+| Enigma Plugin for Roundcube                                             |
+|                                                                         |
+| Copyright (C) 2010-2015 The Roundcube Dev Team                          |
+|                                                                         |
+| Licensed under the GNU General Public License version 3 or              |
+| any later version with exceptions for skins & plugins.                  |
+| See the README file for a full license statement.                       |
+|                                                                         |
++-------------------------------------------------------------------------+
+| Author: Aleksander Machniak <alec@alec.pl>                              |
++-------------------------------------------------------------------------+
+*/
+/**
+* This class contains only hooks and action handlers.
+* Most plugin logic is placed in enigma_engine and enigma_ui classes.
+*/
+class enigma extends rcube_plugin
+{
+public $task = 'mail|settings|cli';
+public $rc;
+public $engine;
+public $ui;
+private $env_loaded = false;
+/**
+* Plugin initialization.
+*/
+function init()
+{
+$this->rc = rcube::get_instance();
+if ($this->rc->task == 'mail') {
+// message parse/display hooks
+$this->add_hook('message_part_structure', array($this, 'part_structure'));
+$this->add_hook('message_part_body', array($this, 'part_body'));
+$this->add_hook('message_body_prefix', array($this, 'status_message'));
+$this->register_action('plugin.enigmaimport', array($this, 'import_file'));
+$this->register_action('plugin.enigmakeys', array($this, 'preferences_ui'));
+// load the Enigma plugin configuration
+$this->load_config();
+$enabled = $this->rc->config->get('enigma_encryption', true);
+// message displaying
+if ($this->rc->action == 'show' || $this->rc->action == 'preview' || $this->rc->action == 'print') {
+$this->add_hook('message_load', array($this, 'message_load'));
+$this->add_hook('template_object_messagebody', array($this, 'message_output'));
+}
+// message composing
+else if ($enabled && $this->rc->action == 'compose') {
+$this->add_hook('message_compose_body', array($this, 'message_compose'));
+$this->load_ui();
+$this->ui->init();
+}
+// message sending (and draft storing)
+else if ($enabled && $this->rc->action == 'send') {
+$this->add_hook('message_ready', array($this, 'message_ready'));
+}
+$this->password_handler();
+}
+else if ($this->rc->task == 'settings') {
+// add hooks for Enigma settings
+$this->add_hook('settings_actions', array($this, 'settings_actions'));
+$this->add_hook('preferences_sections_list', array($this, 'preferences_sections_list'));
+$this->add_hook('preferences_list', array($this, 'preferences_list'));
+$this->add_hook('preferences_save', array($this, 'preferences_save'));
+// register handler for keys/certs management
+$this->register_action('plugin.enigmakeys', array($this, 'preferences_ui'));
+//            $this->register_action('plugin.enigmacerts', array($this, 'preferences_ui'));
+$this->load_ui();
+if (empty($_REQUEST['_framed']) || strpos($this->rc->action, 'plugin.enigma') === 0) {
+$this->ui->add_css();
+}
+$this->password_handler();
+}
+else if ($this->rc->task == 'cli') {
+$this->add_hook('user_delete_commit', array($this, 'user_delete'));
+}
+$this->add_hook('refresh', array($this, 'refresh'));
+}
+/**
+* Plugin environment initialization.
+*/
+function load_env()
+{
+if ($this->env_loaded) {
+return;
+}
+$this->env_loaded = true;
+// Add include path for Enigma classes and drivers
+$include_path = $this->home . '/lib' . PATH_SEPARATOR;
+$include_path .= ini_get('include_path');
+set_include_path($include_path);
+// load the Enigma plugin configuration
+$this->load_config();
+// include localization (if wasn't included before)
+$this->add_texts('localization/');
+}
+/**
+* Plugin UI initialization.
+*/
+function load_ui($all = false)
+{
+if (!$this->ui) {
+// load config/localization
+$this->load_env();
+// Load UI
+$this->ui = new enigma_ui($this, $this->home);
+}
+if ($all) {
+$this->ui->add_css();
+$this->ui->add_js();
+}
+}
+/**
+* Plugin engine initialization.
+*/
+function load_engine()
+{
+if ($this->engine) {
+return $this->engine;
+}
+// load config/localization
+$this->load_env();
+return $this->engine = new enigma_engine($this);
+}
+/**
+* Handler for message_part_structure hook.
+* Called for every part of the message.
+*
+* @param array Original parameters
+*
+* @return array Modified parameters
+*/
+function part_structure($p)
+{
+$this->load_engine();
+return $this->engine->part_structure($p);
+}
+/**
+* Handler for message_part_body hook.
+* Called to get body of a message part.
+*
+* @param array Original parameters
+*
+* @return array Modified parameters
+*/
+function part_body($p)
+{
+$this->load_engine();
+return $this->engine->part_body($p);
+}
+/**
+* Handler for settings_actions hook.
+* Adds Enigma settings section into preferences.
+*
+* @param array Original parameters
+*
+* @return array Modified parameters
+*/
+function settings_actions($args)
+{
+// add labels
+$this->add_texts('localization/');
+// register as settings action
+$args['actions'][] = array(
+'action' => 'plugin.enigmakeys',
+'class'  => 'enigma keys',
+'label'  => 'enigmakeys',
+'title'  => 'enigmakeys',
+'domain' => 'enigma',
+);
+/*
+$args['actions'][] = array(
+'action' => 'plugin.enigmacerts',
+'class'  => 'enigma certs',
+'label'  => 'enigmacerts',
+'title'  => 'enigmacerts',
+'domain' => 'enigma',
+);
+*/
+return $args;
+}
+/**
+* Handler for preferences_sections_list hook.
+* Adds Encryption settings section into preferences sections list.
+*
+* @param array Original parameters
+*
+* @return array Modified parameters
+*/
+function preferences_sections_list($p)
+{
+$p['list']['enigma'] = array(
+'id' => 'enigma', 'section' => $this->gettext('encryption'),
+);
+return $p;
+}
+/**
+* Handler for preferences_list hook.
+* Adds options blocks into Enigma settings sections in Preferences.
+*
+* @param array Original parameters
+*
+* @return array Modified parameters
+*/
+function preferences_list($p)
+{
+if ($p['section'] != 'enigma') {
+return $p;
+}
+$no_override = array_flip((array)$this->rc->config->get('dont_override'));
+$p['blocks']['main']['name'] = $this->gettext('mainoptions');
+if (!isset($no_override['enigma_encryption'])) {
+if (!$p['current']) {
+$p['blocks']['main']['content'] = true;
+return $p;
+}
+$field_id = 'rcmfd_enigma_encryption';
+$input    = new html_checkbox(array(
+'name'  => '_enigma_encryption',
+'id'    => $field_id,
+'value' => 1,
+));
+$p['blocks']['main']['options']['enigma_encryption'] = array(
+'title'   => html::label($field_id, $this->gettext('supportencryption')),
+'content' => $input->show(intval($this->rc->config->get('enigma_encryption'))),
+);
+}
+if (!isset($no_override['enigma_signatures'])) {
+if (!$p['current']) {
+$p['blocks']['main']['content'] = true;
+return $p;
+}
+$field_id = 'rcmfd_enigma_signatures';
+$input    = new html_checkbox(array(
+'name'  => '_enigma_signatures',
+'id'    => $field_id,
+'value' => 1,
+));
+$p['blocks']['main']['options']['enigma_signatures'] = array(
+'title'   => html::label($field_id, $this->gettext('supportsignatures')),
+'content' => $input->show(intval($this->rc->config->get('enigma_signatures'))),
+);
+}
+if (!isset($no_override['enigma_decryption'])) {
+if (!$p['current']) {
+$p['blocks']['main']['content'] = true;
+return $p;
+}
+$field_id = 'rcmfd_enigma_decryption';
+$input    = new html_checkbox(array(
+'name'  => '_enigma_decryption',
+'id'    => $field_id,
+'value' => 1,
+));
+$p['blocks']['main']['options']['enigma_decryption'] = array(
+'title'   => html::label($field_id, $this->gettext('supportdecryption')),
+'content' => $input->show(intval($this->rc->config->get('enigma_decryption'))),
+);
+}
+if (!isset($no_override['enigma_sign_all'])) {
+if (!$p['current']) {
+$p['blocks']['main']['content'] = true;
+return $p;
+}
+$field_id = 'rcmfd_enigma_sign_all';
+$input    = new html_checkbox(array(
+'name'  => '_enigma_sign_all',
+'id'    => $field_id,
+'value' => 1,
+));
+$p['blocks']['main']['options']['enigma_sign_all'] = array(
+'title'   => html::label($field_id, $this->gettext('signdefault')),
+'content' => $input->show($this->rc->config->get('enigma_sign_all') ? 1 : 0),
+);
+}
+if (!isset($no_override['enigma_encrypt_all'])) {
+if (!$p['current']) {
+$p['blocks']['main']['content'] = true;
+return $p;
+}
+$field_id = 'rcmfd_enigma_encrypt_all';
+$input    = new html_checkbox(array(
+'name'  => '_enigma_encrypt_all',
+'id'    => $field_id,
+'value' => 1,
+));
+$p['blocks']['main']['options']['enigma_encrypt_all'] = array(
+'title'   => html::label($field_id, $this->gettext('encryptdefault')),
+'content' => $input->show($this->rc->config->get('enigma_encrypt_all') ? 1 : 0),
+);
+}
+if (!isset($no_override['enigma_attach_pubkey'])) {
+if (!$p['current']) {
+$p['blocks']['main']['content'] = true;
+return $p;
+}
+$field_id = 'rcmfd_enigma_attach_pubkey';
+$input    = new html_checkbox(array(
+'name'  => '_enigma_attach_pubkey',
+'id'    => $field_id,
+'value' => 1,
+));
+$p['blocks']['main']['options']['enigma_attach_pubkey'] = array(
+'title'   => html::label($field_id, $this->gettext('attachpubkeydefault')),
+'content' => $input->show($this->rc->config->get('enigma_attach_pubkey') ? 1 : 0),
+);
+}
+if (!isset($no_override['enigma_password_time'])) {
+if (!$p['current']) {
+$p['blocks']['main']['content'] = true;
+return $p;
+}
+$field_id = 'rcmfd_enigma_password_time';
+$select   = new html_select(array('name' => '_enigma_password_time', 'id' => $field_id));
+foreach (array(1, 5, 10, 15, 30) as $m) {
+$label = $this->gettext(array('name' => 'nminutes', 'vars' => array('m' => $m)));
+$select->add($label, $m);
+}
+$select->add($this->gettext('wholesession'), 0);
+$p['blocks']['main']['options']['enigma_password_time'] = array(
+'title'   => html::label($field_id, $this->gettext('passwordtime')),
+'content' => $select->show(intval($this->rc->config->get('enigma_password_time'))),
+);
+}
+return $p;
+}
+/**
+* Handler for preferences_save hook.
+* Executed on Enigma settings form submit.
+*
+* @param array Original parameters
+*
+* @return array Modified parameters
+*/
+function preferences_save($p)
+{
+if ($p['section'] == 'enigma') {
+$p['prefs'] = array(
+'enigma_signatures'    => (bool) rcube_utils::get_input_value('_enigma_signatures', rcube_utils::INPUT_POST),
+'enigma_decryption'    => (bool) rcube_utils::get_input_value('_enigma_decryption', rcube_utils::INPUT_POST),
+'enigma_encryption'    => (bool) rcube_utils::get_input_value('_enigma_encryption', rcube_utils::INPUT_POST),
+'enigma_sign_all'      => (bool) rcube_utils::get_input_value('_enigma_sign_all', rcube_utils::INPUT_POST),
+'enigma_encrypt_all'   => (bool) rcube_utils::get_input_value('_enigma_encrypt_all', rcube_utils::INPUT_POST),
+'enigma_attach_pubkey' => (bool) rcube_utils::get_input_value('_enigma_attach_pubkey', rcube_utils::INPUT_POST),
+'enigma_password_time' => intval(rcube_utils::get_input_value('_enigma_password_time', rcube_utils::INPUT_POST)),
+);
+}
+return $p;
+}
+/**
+* Handler for keys/certs management UI template.
+*/
+function preferences_ui()
+{
+$this->load_ui();
+$this->ui->init();
+}
+/**
+* Handler for message_body_prefix hook.
+* Called for every displayed (content) part of the message.
+* Adds infobox about signature verification and/or decryption
+* status above the body.
+*
+* @param array Original parameters
+*
+* @return array Modified parameters
+*/
+function status_message($p)
+{
+$this->load_ui();
+return $this->ui->status_message($p);
+}
+/**
+* Handler for message_load hook.
+* Check message bodies and attachments for keys/certs.
+*/
+function message_load($p)
+{
+$this->load_ui();
+return $this->ui->message_load($p);
+}
+/**
+* Handler for template_object_messagebody hook.
+* This callback function adds a box below the message content
+* if there is a key/cert attachment available
+*/
+function message_output($p)
+{
+$this->load_ui();
+return $this->ui->message_output($p);
+}
+/**
+* Handler for attached keys/certs import
+*/
+function import_file()
+{
+$this->load_ui();
+$this->ui->import_file();
+}
+/**
+* Handle password submissions
+*/
+function password_handler()
+{
+$this->load_engine();
+$this->engine->password_handler();
+}
+/**
+* Handle message_ready hook (encryption/signing)
+*/
+function message_ready($p)
+{
+$this->load_ui();
+return $this->ui->message_ready($p);
+}
+/**
+* Handle message_compose_body hook
+*/
+function message_compose($p)
+{
+$this->load_ui();
+return $this->ui->message_compose($p);
+}
+/**
+* Handler for refresh hook.
+*/
+function refresh($p)
+{
+// calling enigma_engine constructor to remove passwords
+// stored in session after expiration time
+$this->load_engine();
+return $p;
+}
+/**
+* Handle delete_user_commit hook
+*/
+function user_delete($p)
+{
+$this->load_engine();
+$p['abort'] = $p['abort'] || !$this->engine->delete_user_data($p['username']);
+return $p;
+}
+}

Mercurial > hg > rc1

comparison plugins/enigma/enigma.php @ 0:1e000243b222