scripts/xmppconfirmhandler.php

   1 #!/usr/bin/env php
   2 <?php
   3 /*
   4  * StatusNet - a distributed open-source microblogging tool
   5  * Copyright (C) 2008, 2009, StatusNet, Inc.
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU Affero General Public License as published by
   9  * the Free Software Foundation, either version 3 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU Affero General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Affero General Public License
  18  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19  */
  20
  21 define('INSTALLDIR', realpath(dirname(__FILE__) . '/..'));
  22
  23 $shortoptions = 'i::';
  24 $longoptions = array('id::');
  25
  26 $helptext = <<<END_OF_JABBER_HELP
  27 Daemon script for pushing new confirmations to Jabber users.
  28
  29     -i --id           Identity (default none)
  30
  31 END_OF_JABBER_HELP;
  32
  33 require_once INSTALLDIR.'/scripts/commandline.inc';
  34 require_once INSTALLDIR . '/lib/jabber.php';
  35 require_once INSTALLDIR . '/lib/xmppqueuehandler.php';
  36
  37 define('CLAIM_TIMEOUT', 1200);
  38
  39 class XmppConfirmHandler extends XmppQueueHandler
  40 {
  41     var $_id = 'confirm';
  42
  43     function class_name()
  44     {
  45         return 'XmppConfirmHandler';
  46     }
  47
  48     function run()
  49     {
  50         if (!$this->start()) {
  51             return false;
  52         }
  53         $this->log(LOG_INFO, 'checking for queued confirmations');
  54         do {
  55             $confirm = $this->next_confirm();
  56             if ($confirm) {
  57                 $this->log(LOG_INFO, 'Sending confirmation for ' . $confirm->address);
  58                 $user = User::staticGet($confirm->user_id);
  59                 if (!$user) {
  60                     $this->log(LOG_WARNING, 'Confirmation for unknown user ' . $confirm->user_id);
  61                     continue;
  62                 }
  63                 $success = jabber_confirm_address($confirm->code,
  64                                                   $user->nickname,
  65                                                   $confirm->address);
  66                 if (!$success) {
  67                     $this->log(LOG_ERR, 'Confirmation failed for ' . $confirm->address);
  68                     # Just let the claim age out; hopefully things work then
  69                     continue;
  70                 } else {
  71                     $this->log(LOG_INFO, 'Confirmation sent for ' . $confirm->address);
  72                     # Mark confirmation sent; need a dupe so we don't have the WHERE clause
  73                     $dupe = Confirm_address::staticGet('code', $confirm->code);
  74                     if (!$dupe) {
  75                         common_log(LOG_WARNING, 'Could not refetch confirm', __FILE__);
  76                         continue;
  77                     }
  78                     $orig = clone($dupe);
  79                     $dupe->sent = $dupe->claimed;
  80                     $result = $dupe->update($orig);
  81                     if (!$result) {
  82                         common_log_db_error($dupe, 'UPDATE', __FILE__);
  83                         # Just let the claim age out; hopefully things work then
  84                         continue;
  85                     }
  86                     $dupe->free();
  87                     unset($dupe);
  88                 }
  89                 $user->free();
  90                 unset($user);
  91                 $confirm->free();
  92                 unset($confirm);
  93                 $this->idle(0);
  94             } else {
  95 #                $this->clear_old_confirm_claims();
  96                 $this->idle(10);
  97             }
  98         } while (true);
  99         if (!$this->finish()) {
 100             return false;
 101         }
 102         return true;
 103     }
 104
 105     function next_confirm()
 106     {
 107         $confirm = new Confirm_address();
 108         $confirm->whereAdd('claimed IS null');
 109         $confirm->whereAdd('sent IS null');
 110         # XXX: eventually we could do other confirmations in the queue, too
 111         $confirm->address_type = 'jabber';
 112         $confirm->orderBy('modified DESC');
 113         $confirm->limit(1);
 114         if ($confirm->find(true)) {
 115             $this->log(LOG_INFO, 'Claiming confirmation for ' . $confirm->address);
 116                 # working around some weird DB_DataObject behaviour
 117             $confirm->whereAdd(''); # clears where stuff
 118             $original = clone($confirm);
 119             $confirm->claimed = common_sql_now();
 120             $result = $confirm->update($original);
 121             if ($result) {
 122                 $this->log(LOG_INFO, 'Succeeded in claim! '. $result);
 123                 return $confirm;
 124             } else {
 125                 $this->log(LOG_INFO, 'Failed in claim!');
 126                 return false;
 127             }
 128         }
 129         return null;
 130     }
 131
 132     function clear_old_confirm_claims()
 133     {
 134         $confirm = new Confirm();
 135         $confirm->claimed = null;
 136         $confirm->whereAdd('now() - claimed > '.CLAIM_TIMEOUT);
 137         $confirm->update(DB_DATAOBJECT_WHEREADD_ONLY);
 138         $confirm->free();
 139         unset($confirm);
 140     }
 141 }
 142
 143 // Abort immediately if xmpp is not enabled, otherwise the daemon chews up
 144 // lots of CPU trying to connect to unconfigured servers
 145 if (common_config('xmpp','enabled')==false) {
 146     print "Aborting daemon - xmpp is disabled\n";
 147     exit();
 148 }
 149
 150 if (have_option('i')) {
 151     $id = get_option_value('i');
 152 } else if (have_option('--id')) {
 153     $id = get_option_value('--id');
 154 } else if (count($args) > 0) {
 155     $id = $args[0];
 156 } else {
 157     $id = null;
 158 }
 159
 160 $handler = new XmppConfirmHandler($id);
 161
 162 $handler->runOnce();
 163