plugins/ActivityModeration/classes/Deleted_notice.php

   1 <?php
   2 /*
   3  * Laconica - a distributed open-source microblogging tool
   4  * Copyright (C) 2008, 2009, Control Yourself, Inc.
   5  *
   6  * This program is free software: you can redistribute it and/or modify
   7  * it under the terms of the GNU Affero General Public License as published by
   8  * the Free Software Foundation, either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.     See the
  14  * GNU Affero General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Affero General Public License
  17  * along with this program.     If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 if (!defined('GNUSOCIAL')) { exit(1); }
  21
  22 /**
  23  * Table Definition for deleted_notice
  24  */
  25
  26 class Deleted_notice extends Managed_DataObject
  27 {
  28     public $__table = 'deleted_notice';      // table name
  29     public $id;                              // int(4)  primary_key not_null
  30     public $profile_id;                      // int(4)   not_null
  31     public $uri;                             // varchar(191)  unique_key   not 255 because utf8mb4 takes more space
  32     public $act_uri;                         // varchar(191)  unique_key   not 255 because utf8mb4 takes more space
  33     public $act_created;                     // datetime()   not_null
  34     public $created;                         // datetime()   not_null
  35
  36     public static function schemaDef()
  37     {
  38         return array(
  39             'fields' => array(
  40                 'id' => array('type' => 'int', 'not null' => true, 'description' => 'notice ID'),
  41                 'profile_id' => array('type' => 'int', 'not null' => true, 'description' => 'profile that deleted the notice'),
  42                 'uri' => array('type' => 'varchar', 'length' => 191, 'description' => 'URI of the deleted notice'),
  43                 'act_uri' => array('type' => 'varchar', 'length' => 191, 'description' => 'URI of the delete activity, may exist in notice table'),
  44                 'act_created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date the notice record was created'),
  45                 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date the notice record was deleted'),
  46             ),
  47             'primary key' => array('id'),
  48             'unique keys' => array(
  49                 'deleted_notice_uri_key' => array('uri'),
  50                 'deleted_notice_act_uri_key' => array('act_uri'),
  51             ),
  52             'indexes' => array(
  53                 'deleted_notice_profile_id_idx' => array('profile_id'),
  54             ),
  55         );
  56     }
  57
  58     public static function addNew(Notice $notice, Profile $actor=null)
  59     {
  60         if (is_null($actor)) {
  61             $actor = $notice->getProfile();
  62         }
  63
  64         if ($notice->getProfile()->hasRole(Profile_role::DELETED)) {
  65             // Don't emit notices if the notice author is (being) deleted
  66             return false;
  67         }
  68
  69         $act = new Activity();
  70         $act->verb = ActivityVerb::DELETE;
  71         $act->time = time();
  72         $act->id   = $notice->getUri();
  73
  74         $act->content = sprintf(_m('<a href="%1$s">%2$s</a> deleted notice <a href="%3$s">{{%4$s}}</a>.'),
  75                             htmlspecialchars($actor->getUrl()),
  76                             htmlspecialchars($actor->getBestName()),
  77                             htmlspecialchars($notice->getUrl()),
  78                             htmlspecialchars($notice->getUri())
  79                            );
  80
  81         $act->actor = $actor->asActivityObject();
  82         $act->target = new ActivityObject();    // We don't save the notice object, as it's supposed to be removed!
  83         $act->target->id = $notice->getUri();
  84         $act->target->type = $notice->getObjectType();
  85         $act->objects = array(clone($act->target));
  86
  87         $url = $notice->getUrl();
  88         $act->selfLink = $url;
  89         $act->editLink = $url;
  90
  91         // This will make ActivityModeration run saveObjectFromActivity which adds
  92         // a new Deleted_notice entry in the database as well as deletes the notice
  93         // if the actor has permission to do so.
  94         $stored = Notice::saveActivity($act, $actor);
  95
  96         return $stored;
  97     }
  98
  99     static public function fromStored(Notice $stored)
 100     {
 101         $class = get_called_class();
 102         $object = new $class;
 103         $object->uri = $stored->getUri();   // Lookup by delete activity's URI! (that's what is _stored_ in our db!)
 104         if (!$object->find(true)) {
 105             throw new NoResultException($object);
 106         }
 107         return $object;
 108     }
 109
 110     // The one who deleted the notice, not the notice's author
 111     public function getActor()
 112     {
 113         return Profile::getByID($this->profile_id);
 114     }
 115
 116     // As above: The one who deleted the notice, not the notice's author
 117     public function getActorObject()
 118     {
 119         return $this->getActor()->asActivityObject();
 120     }
 121
 122     static public function getObjectType()
 123     {
 124         return 'activity';
 125     }
 126
 127     protected $_stored = array();
 128
 129     public function getStored()
 130     {
 131         $uri = $this->getUri();
 132         if (!isset($this->_stored[$uri])) {
 133             $this->_stored[$uri] = Notice::getByPK('uri', $uri);
 134         }
 135         return $this->_stored[$uri];
 136     }
 137
 138     public function getUri()
 139     {
 140         return $this->uri;
 141     }
 142
 143     public function asActivityObject(Profile $scoped=null)
 144     {
 145         $actobj = new ActivityObject();
 146         $actobj->id = $this->getUri();
 147         $actobj->type = ActivityObject::ACTIVITY;
 148         $actobj->actor = $this->getActorObject();
 149         $actobj->target = new ActivityObject();
 150         $actobj->target->id = $this->getUri();
 151         // FIXME: actobj->target->type? as in extendActivity, and actobj->target->actor maybe?
 152         $actobj->objects = array(clone($actobj->target));
 153         $actobj->verb = ActivityVerb::DELETE;
 154         $actobj->title = ActivityUtils::verbToTitle($actobj->verb);
 155
 156         $actor = $this->getActor();
 157         $actobj->content = sprintf(_m('<a href="%1$s">%2$s</a> deleted notice {{%3$s}}.'),
 158                             htmlspecialchars($actor->getUrl()),
 159                             htmlspecialchars($actor->getBestName()),
 160                             htmlspecialchars($this->getUri())
 161                            );
 162
 163         return $actobj;
 164     }
 165
 166     static public function extendActivity(Notice $stored, Activity $act, Profile $scoped=null)
 167     {
 168         // the original notice id and type is still stored in the Notice table
 169         // so we use that information to describe the delete activity
 170         $act->target = new ActivityObject();
 171         $act->target->id = $stored->getUri();
 172         $act->target->type = $stored->getObjectType();
 173         $act->objects = array(clone($act->target));
 174
 175         $act->title = ActivityUtils::verbToTitle($act->verb);
 176     }
 177
 178     static public function beforeSchemaUpdate()
 179     {
 180         $table = strtolower(get_called_class());
 181         $schema = Schema::get();
 182         $schemadef = $schema->getTableDef($table);
 183
 184         // 2015-10-03 We change the meaning of the 'uri' field and move its
 185         // content to the 'act_uri' for the deleted activity. act_created is
 186         // added too.
 187         if (isset($schemadef['fields']['act_uri'])) {
 188             // We already have the act_uri field, so no need to migrate to it.
 189             return;
 190         }
 191         echo "\nFound old $table table, upgrading it to contain 'act_uri' and 'act_created' field...";
 192
 193         $schemadef['fields']['act_uri'] = array('type' => 'varchar', 'not null' => true, 'length' => 191, 'description' => 'URI of the deleted notice');
 194         $schemadef['fields']['act_created'] = array('type' => 'datetime', 'not null' => true, 'description' => 'datetime the notice record was created');
 195         unset($schemadef['unique keys']);
 196         $schema->ensureTable($table, $schemadef);
 197
 198         $deleted = new Deleted_notice();
 199         $result = $deleted->find();
 200         if ($result === false) {
 201             print "\nFound no deleted_notice entries, continuing...";
 202             return true;
 203         }
 204         print "\nFound $result deleted_notice entries, aligning with new database layout: ";
 205         while($deleted->fetch()) {
 206             $orig = clone($deleted);
 207             $deleted->act_uri = $deleted->uri;
 208             // this is a fake URI just to have something to put there to avoid NULL. crc32 of uri is to avoid collisions
 209             $deleted->uri = TagURI::mint(strtolower(get_called_class()).':%d:%s:%s:%s:crc32=%x',
 210                                 $deleted->profile_id,
 211                                 ActivityUtils::resolveUri(self::getObjectType(), true),
 212                                 'unknown',
 213                                 common_date_iso8601($deleted->created),
 214                                 crc32($deleted->act_uri)
 215                             );
 216             $deleted->act_created = $deleted->created;  // we don't actually know when the notice was created
 217             $deleted->updateWithKeys($orig, 'id');
 218             print ".";
 219         }
 220         print "DONE.\n";
 221         print "Resuming core schema upgrade...";
 222     }
 223
 224 }