3 * Laconica - a distributed open-source microblogging tool
4 * Copyright (C) 2008, 2009, Control Yourself, Inc.
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.
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.
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/>.
20 if (!defined('GNUSOCIAL')) { exit(1); }
23 * Table Definition for deleted_notice
26 class Deleted_notice extends Managed_DataObject
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 $created; // datetime() not_null
34 public $deleted; // datetime() not_null
36 public static function schemaDef()
40 'id' => array('type' => 'int', 'not null' => true, 'description' => 'identity of notice'),
41 'profile_id' => array('type' => 'int', 'not null' => true, 'description' => 'author of 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'),
47 'primary key' => array('id'),
48 'unique keys' => array(
49 'deleted_notice_act_uri_key' => array('act_uri'),
52 'deleted_notice_profile_id_idx' => array('profile_id'),
57 public static function addNew(Notice $notice, Profile $actor=null)
59 if (is_null($actor)) {
60 $actor = $notice->getProfile();
63 if ($notice->getProfile()->hasRole(Profile_role::DELETED)) {
64 // Don't emit notices if the notice author is (being) deleted
68 $act = new Activity();
69 $act->type = ActivityObject::ACTIVITY;
70 $act->verb = ActivityVerb::DELETE;
72 $act->id = self::newUri($actor, $notice);
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())
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->objects = array(clone($act->target));
86 $url = $notice->getUrl();
87 $act->selfLink = $url;
88 $act->editLink = $url;
90 // This will make ActivityModeration run saveObjectFromActivity which adds
91 // a new Deleted_notice entry in the database as well as deletes the notice
92 // if the actor has permission to do so.
93 $stored = Notice::saveActivity($act, $actor);
98 static public function fromStored(Notice $stored)
100 $class = get_called_class();
101 $object = new $class;
102 $object->act_uri = $stored->getUri();
103 if (!$object->find(true)) {
104 throw new NoResultException($object);
109 public function getActor()
111 return Profile::getByID($this->profile_id);
114 static public function getObjectType()
119 protected $_stored = array();
121 public function getStored()
123 $uri = $this->getTargetUri();
124 if (!isset($this->_stored[$uri])) {
125 $stored = new Notice();
127 if (!$stored->find(true)) {
128 throw new NoResultException($stored);
130 $this->_stored[$uri] = $stored;
132 return $this->_stored[$uri];
135 public function getTargetUri()
137 return $this->act_uri;
140 public function getUri()
145 public function asActivityObject(Profile $scoped=null)
147 $actobj = new ActivityObject();
148 $actobj->id = $this->getUri();
149 $actobj->type = ActivityObject::ACTIVITY;
150 $actobj->actor = $this->getActorObject();
151 $actobj->target = new ActivityObject();
152 $actobj->target->id = $this->getTargetUri();
153 $actobj->objects = array(clone($actobj->target));
154 $actobj->verb = ActivityVerb::DELETE;
155 $actobj->title = ActivityUtils::verbToTitle($actobj->verb);
157 $actor = $this->getActor();
158 $actobj->content = sprintf(_m('<a href="%1$s">%2$s</a> deleted notice {{%3$s}}.'),
159 htmlspecialchars($actor->getUrl()),
160 htmlspecialchars($actor->getBestName()),
161 htmlspecialchars($actor->getTargetUri())
167 static public function extendActivity(Notice $stored, Activity $act, Profile $scoped=null)
169 $object = self::fromStored($stored);
171 $act->target = $object->asActivityObject();
172 $act->objects = array(clone($act->target));
174 $act->context->replyToID = $object->getTargetUri();
175 $act->title = ActivityUtils::verbToTitle($act->verb);
178 static function newUri(Profile $actor, Managed_DataObject $object, $created=null)
180 if (is_null($created)) {
181 $created = common_sql_now();
183 return TagURI::mint(strtolower(get_called_class()).':%d:%s:%d:%s',
185 ActivityUtils::resolveUri($object->getObjectType(), true),
187 common_date_iso8601($created));
190 static public function beforeSchemaUpdate()
192 $table = strtolower(get_called_class());
193 $schema = Schema::get();
194 $schemadef = $schema->getTableDef($table);
196 // 2015-10-03 We change the meaning of the 'uri' field and move its
197 // content to the 'act_uri' for the deleted activity. act_created is
199 if (isset($schemadef['fields']['act_uri'])) {
200 // We already have the act_uri field, so no need to migrate to it.
203 echo "\nFound old $table table, upgrading it to contain 'act_uri' and 'act_created' field...";
205 $schemadef['fields']['act_uri'] = array('type' => 'varchar', 'not null' => true, 'length' => 191, 'description' => 'URI of the delete activity, may exist in notice table');
206 $schemadef['fields']['act_created'] = array('type' => 'datetime', 'not null' => true, 'description' => 'date the notice record was created');
207 unset($schemadef['unique keys']);
208 $schema->ensureTable($table, $schemadef);
210 $deleted = new Deleted_notice();
211 $result = $deleted->find();
212 if ($result === false) {
213 print "\nFound no deleted_notice entries, continuing...";
216 print "\nFound $result deleted_notice entries, aligning with new database layout: ";
217 while($deleted->fetch()) {
218 $orig = clone($deleted);
219 $deleted->act_uri = $deleted->uri;
220 // this is a fake URI just to have something to put there to avoid NULL
221 $deleted->uri = TagURI::mint(strtolower(get_called_class()).':%d:%s:%s:%s',
222 $deleted->profile_id,
223 ActivityUtils::resolveUri(self::getObjectType(), true),
225 common_date_iso8601($deleted->created));
226 $deleted->act_created = $deleted->created; // we don't actually know when the notice was created
227 $deleted->updateWithKeys($orig, 'id');
231 print "Resuming core schema upgrade...";