]> git.mxchange.org Git - friendica-addons.git/blobdiff - securemail/securemail.php
Merge pull request #948 from nupplaphil/task/di_config
[friendica-addons.git] / securemail / securemail.php
index 306d12b43d2908278f6bf99237279ab40eab98c3..6e6658682271776471d7a19a2123f719ff3e8886 100644 (file)
-<?php\r
-/**\r
- * Name: Secure Mail\r
- * Description: Send notification mail encrypted with user-defined public GPG key\r
- * Version: 1.0\r
- * Author: Fabio Comuni <http://kirgroup.com/profile/fabrixxm>\r
- */\r
- require_once 'php-gpg/libs/GPG.php';\r
-\r
- function securemail_install() {\r
-    register_hook('plugin_settings', 'addon/securemail/securemail.php', 'securemail_settings');\r
-    register_hook('plugin_settings_post', 'addon/securemail/securemail.php', 'securemail_settings_post');\r
-\r
-    register_hook('emailer_send_prepare',  'addon/securemail/securemail.php', 'securemail_emailer_send_prepare');\r
-\r
-    logger("installed securemail");\r
-}\r
-\r
-function securemail_uninstall() {\r
-    unregister_hook('plugin_settings', 'addon/securemail/securemail.php', 'securemail_settings');\r
-    unregister_hook('plugin_settings_post', 'addon/securemail/securemail.php', 'securemail_settings_post');\r
-\r
-    unregister_hook('emailer_send_prepare',  'addon/securemail/securemail.php', 'securemail_emailer_send_prepare');\r
-\r
-    logger("removed securemail");\r
-}\r
-\r
-\r
-function securemail_settings(&$a,&$s){\r
-    if(! local_user())\r
-           return;\r
-\r
-    $enable_checked = (intval(get_pconfig(local_user(),'securemail','enable')) ? ' checked="checked"' : '');\r
-    $publickey = get_pconfig(local_user(),'securemail','pkey');\r
-\r
-    # all of this should be in a template...\r
-    $s .= '<span id="settings_securemail_inflated" class="settings-block fakelink" style="display: block;" onclick="openClose(\'settings_securemail_expanded\'); openClose(\'settings_securemail_inflated\');">';\r
-    $s .= '<h3>' . t('"Secure Mail" Settings').'</h3>';\r
-    $s .= '</span>';\r
-    $s .= '<div id="settings_securemail_expanded" class="settings-block" style="display: none;">';\r
-    $s .= '<span class="fakelink" onclick="openClose(\'settings_securemail_expanded\'); openClose(\'settings_securemail_inflated\');">';\r
-    $s .= '<h3>' . t('"Secure Mail" Settings').'</h3>';\r
-    $s .= '</span>';\r
-    $s .= '<div id="securemail-wrapper">';\r
-\r
-    $s .= '<input id="securemail-enable" type="checkbox" name="securemail-enable" value="1"'.$enable_checked.' />';\r
-    $s .= '<label id="securemail-enable-label" for="securemail-enable">'.t('Enable Secure Mail').'</label>';\r
-\r
-    $s .= '<div class="clear"></div>';\r
-    $s .= '<label id="securemail-label" for="securemail-pkey">'.t('Public key').' </label>';\r
-    $s .= '<textarea id="securemail-pkey" name="securemail-pkey">'.$publickey.'</textarea>';\r
-    $s .= '</div><div class="clear"></div>';\r
-\r
-    $s .= '<div class="settings-submit-wrapper" ><input type="submit" id="securemail-submit" name="securemail-submit" class="settings-submit" value="' . t('Save Settings') . '" /></div>';\r
-    $s .= '</div>';\r
-\r
-    return;\r
-}\r
-function securemail_settings_post(&$a, &$b){\r
-\r
-    if(! local_user())\r
-        return;\r
-\r
-    if($_POST['securemail-submit']) {\r
-               set_pconfig(local_user(),'securemail','pkey',trim($_POST['securemail-pkey']));\r
-               $enable = ((x($_POST,'securemail-enable')) ? 1 : 0);\r
-               set_pconfig(local_user(),'securemail','enable', $enable);\r
-               info( t('Secure Mail Settings saved.') . EOL);\r
-    }\r
-}\r
-\r
-function securemail_emailer_send_prepare(&$a, &$b) {\r
-    if (!x($b,'uid')) return;\r
-       $uid = $b['uid'];\r
-\r
-    $enable_checked = get_pconfig($uid,'securemail','enable');\r
-    if (!$enable_checked) return;\r
-\r
-    $public_key_ascii = get_pconfig($uid,'securemail','pkey');\r
-\r
-    $gpg = new GPG();\r
-\r
-    # create an instance of a GPG public key object based on ASCII key\r
-    $pub_key = new GPG_Public_Key($public_key_ascii);\r
-\r
-    # using the key, encrypt your plain text using the public key\r
-    $txt_encrypted = $gpg->encrypt($pub_key,$b['textVersion']);\r
-    $html_encrypted = $gpg->encrypt($pub_key,$b['htmlVersion']);\r
-\r
-    $b['textVersion'] = $txt_encrypted;\r
-    $b['htmlVersion'] = $html_encrypted;\r
-    #var_dump($b);\r
-}\r
+<?php
+/**
+ * Name: Secure Mail
+ * Description: Send notification mail encrypted with user-defined public GPG key
+ * Version: 2.0
+ * Author: Fabio Comuni <http://kirgroup.com/profile/fabrixxm>
+ */
+
+use Friendica\App;
+use Friendica\Core\Hook;
+use Friendica\Core\Logger;
+use Friendica\Core\Renderer;
+use Friendica\DI;
+use Friendica\Util\Emailer;
+
+require_once __DIR__ . '/vendor/autoload.php';
+
+function securemail_install()
+{
+       Hook::register('addon_settings', 'addon/securemail/securemail.php', 'securemail_settings');
+       Hook::register('addon_settings_post', 'addon/securemail/securemail.php', 'securemail_settings_post');
+
+       Hook::register('emailer_send_prepare', 'addon/securemail/securemail.php', 'securemail_emailer_send_prepare');
+
+       Logger::log('installed securemail');
+}
+
+function securemail_uninstall()
+{
+       Hook::unregister('addon_settings', 'addon/securemail/securemail.php', 'securemail_settings');
+       Hook::unregister('addon_settings_post', 'addon/securemail/securemail.php', 'securemail_settings_post');
+
+       Hook::unregister('emailer_send_prepare', 'addon/securemail/securemail.php', 'securemail_emailer_send_prepare');
+
+       Logger::log('removed securemail');
+}
+
+/**
+ * @brief Build user settings form
+ *
+ * @link  https://github.com/friendica/friendica/blob/develop/doc/Addons.md#addon_settings 'addon_settings' hook
+ *
+ * @param App    $a App instance
+ * @param string $s output html
+ *
+ * @see   App
+ */
+function securemail_settings(App &$a, &$s)
+{
+       if (!local_user()) {
+               return;
+       }
+
+       $enable = intval(DI::pConfig()->get(local_user(), 'securemail', 'enable'));
+       $publickey = DI::pConfig()->get(local_user(), 'securemail', 'pkey');
+
+       $t = Renderer::getMarkupTemplate('admin.tpl', 'addon/securemail/');
+
+       $s .= Renderer::replaceMacros($t, [
+               '$title' => DI::l10n()->t('"Secure Mail" Settings'),
+               '$submit' => DI::l10n()->t('Save Settings'),
+               '$test' => DI::l10n()->t('Save and send test'), //NOTE: update also in 'post'
+               '$enable' => ['securemail-enable', DI::l10n()->t('Enable Secure Mail'), $enable, ''],
+               '$publickey' => ['securemail-pkey', DI::l10n()->t('Public key'), $publickey, DI::l10n()->t('Your public PGP key, ascii armored format'), 'rows="10"']
+       ]);
+}
+
+/**
+ * @brief Handle data from user settings form
+ *
+ * @link  https://github.com/friendica/friendica/blob/develop/doc/Addons.md#addon_settings_post 'addon_settings_post' hook
+ *
+ * @param App   $a App instance
+ * @param array $b hook data
+ *
+ * @see   App
+ */
+function securemail_settings_post(App &$a, array &$b)
+{
+       if (!local_user()) {
+               return;
+       }
+
+       if ($_POST['securemail-submit']) {
+               DI::pConfig()->set(local_user(), 'securemail', 'pkey', trim($_POST['securemail-pkey']));
+               $enable = (!empty($_POST['securemail-enable']) ? 1 : 0);
+               DI::pConfig()->set(local_user(), 'securemail', 'enable', $enable);
+               info(DI::l10n()->t('Secure Mail Settings saved.') . EOL);
+
+               if ($_POST['securemail-submit'] == DI::l10n()->t('Save and send test')) {
+                       $sitename = DI::config()->get('config', 'sitename');
+
+                       $hostname = DI::baseUrl()->getHostname();
+                       if (strpos($hostname, ':')) {
+                               $hostname = substr($hostname, 0, strpos($hostname, ':'));
+                       }
+
+                       $sender_email = DI::config()->get('config', 'sender_email');
+                       if (empty($sender_email)) {
+                               $sender_email = 'noreply@' . $hostname;
+                       }
+
+                       $subject = 'Friendica - Secure Mail - Test';
+                       $message = 'This is a test message from your Friendica Secure Mail addon.';
+
+                       $params = [
+                               'uid' => local_user(),
+                               'fromName' => $sitename,
+                               'fromEmail' => $sender_email,
+                               'toEmail' => $a->user['email'],
+                               'messageSubject' => $subject,
+                               'htmlVersion' => "<p>{$message}</p>",
+                               'textVersion' => $message,
+                       ];
+
+                       // enable addon for test
+                       DI::pConfig()->set(local_user(), 'securemail', 'enable', 1);
+
+                       $res = Emailer::send($params);
+
+                       // revert to saved value
+                       DI::pConfig()->set(local_user(), 'securemail', 'enable', $enable);
+
+                       if ($res) {
+                               info(DI::l10n()->t('Test email sent') . EOL);
+                       } else {
+                               notice(DI::l10n()->t('There was an error sending the test email') . EOL);
+                       }
+               }
+       }
+}
+
+/**
+ * @brief Encrypt notification emails text
+ *
+ * @link  https://github.com/friendica/friendica/blob/develop/doc/Addons.md#emailer_send_prepare 'emailer_send_prepare' hook
+ *
+ * @param App   $a App instance
+ * @param array $b hook data
+ *
+ * @see   App
+ */
+function securemail_emailer_send_prepare(App &$a, array &$b)
+{
+       if (empty($b['uid'])) {
+               return;
+       }
+
+       $uid = $b['uid'];
+
+       $enable_checked = DI::pConfig()->get($uid, 'securemail', 'enable');
+       if (!$enable_checked) {
+               return;
+       }
+
+       $public_key_ascii = DI::pConfig()->get($uid, 'securemail', 'pkey');
+
+       preg_match('/-----BEGIN ([A-Za-z ]+)-----/', $public_key_ascii, $matches);
+       $marker = empty($matches[1]) ? 'MESSAGE' : $matches[1];
+       $public_key = OpenPGP::unarmor($public_key_ascii, $marker);
+
+       $key = OpenPGP_Message::parse($public_key);
+
+       $data = new OpenPGP_LiteralDataPacket($b['textVersion'], [
+               'format' => 'u',
+               'filename' => 'encrypted.gpg'
+       ]);
+       $encrypted = OpenPGP_Crypt_Symmetric::encrypt($key, new OpenPGP_Message([$data]));
+       $armored_encrypted = wordwrap(
+               OpenPGP::enarmor($encrypted->to_bytes(), 'PGP MESSAGE'),
+               64,
+               "\n",
+               true
+       );
+
+       $b['textVersion'] = $armored_encrypted;
+       $b['htmlVersion'] = null;
+}