plugins/UserFlag/clearflag.php

   1 <?php
   2 /**
   3  * Clear all flags for a profile
   4  *
   5  * PHP version 5
   6  *
   7  * @category Action
   8  * @package  StatusNet
   9  * @author   Evan Prodromou <evan@status.net>
  10  * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
  11  * @link     http://status.net/
  12  *
  13  * StatusNet - the distributed open-source microblogging tool
  14  * Copyright (C) 2009, StatusNet, Inc.
  15  *
  16  * This program is free software: you can redistribute it and/or modify
  17  * it under the terms of the GNU Affero General Public License as published by
  18  * the Free Software Foundation, either version 3 of the License, or
  19  * (at your option) any later version.
  20  *
  21  * This program is distributed in the hope that it will be useful,
  22  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  23  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  24  * GNU Affero General Public License for more details.
  25  *
  26  * You should have received a copy of the GNU Affero General Public License
  27  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  28  */
  29
  30 if (!defined('STATUSNET')) {
  31     exit(1);
  32 }
  33
  34 /**
  35  * Action to clear flags for a profile
  36  *
  37  * @category Action
  38  * @package  StatusNet
  39  * @author   Evan Prodromou <evan@status.net>
  40  * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
  41  * @link     http://status.net/
  42  */
  43 class ClearflagAction extends ProfileFormAction
  44 {
  45     /**
  46      * Take arguments for running
  47      *
  48      * @param array $args $_REQUEST args
  49      *
  50      * @return boolean success flag
  51      */
  52
  53     function prepare($args)
  54     {
  55         if (!parent::prepare($args)) {
  56             return false;
  57         }
  58
  59         $user = common_current_user();
  60
  61         assert(!empty($user)); // checked above
  62         assert(!empty($this->profile)); // checked above
  63
  64         return true;
  65     }
  66
  67     /**
  68      * Handle request
  69      *
  70      * Overriding the base Action's handle() here to deal check
  71      * for Ajax and return an HXR response if necessary
  72      *
  73      * @param array $args $_REQUEST args; handled in prepare()
  74      *
  75      * @return void
  76      */
  77     function handle($args)
  78     {
  79         if ($_SERVER['REQUEST_METHOD'] == 'POST') {
  80             $this->handlePost();
  81             if (!$this->boolean('ajax')) {
  82                 $this->returnToPrevious();
  83             }
  84         }
  85     }
  86
  87     /**
  88      * Handle POST
  89      *
  90      * Executes the actions; deletes all flags
  91      *
  92      * @return void
  93      */
  94     function handlePost()
  95     {
  96         $ufp = new User_flag_profile();
  97
  98         $result = $ufp->query('UPDATE user_flag_profile ' .
  99                               'SET cleared = now() ' .
 100                               'WHERE cleared is null ' .
 101                               'AND profile_id = ' . $this->profile->id);
 102
 103         if ($result == false) {
 104             // TRANS: Server exception given when flags could not be cleared.
 105             $msg = sprintf(_m('Couldn\'t clear flags for profile "%s".'),
 106                            $this->profile->nickname);
 107             throw new ServerException($msg);
 108         }
 109
 110         $ufp->free();
 111
 112         if ($this->boolean('ajax')) {
 113             $this->ajaxResults();
 114         }
 115     }
 116
 117     /**
 118      * Return results in ajax form
 119      *
 120      * @return void
 121      */
 122     function ajaxResults()
 123     {
 124         header('Content-Type: text/xml;charset=utf-8');
 125         $this->xw->startDocument('1.0', 'UTF-8');
 126         $this->elementStart('html');
 127         $this->elementStart('head');
 128         // TRANS: Title for AJAX form to indicated that flags were removed.
 129         $this->element('title', null, _m('Flags cleared'));
 130         $this->elementEnd('head');
 131         $this->elementStart('body');
 132         // TRANS: Body element for "flags cleared" form.
 133         $this->element('p', 'cleared', _m('Cleared'));
 134         $this->elementEnd('body');
 135         $this->elementEnd('html');
 136     }
 137 }