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 $act_created; // datetime() not_null
34 public $created; // datetime() not_null
36 public static function schemaDef()
40 'id' => array('type' => 'int', 'not null' => true, 'description' => 'notice ID'),
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_uri_key' => array('uri'),
50 'deleted_notice_act_uri_key' => array('act_uri'),
53 'deleted_notice_profile_id_idx' => array('profile_id'),
58 public static function addNew(Notice $notice, Profile $actor=null)
60 if (is_null($actor)) {
61 $actor = $notice->getProfile();
64 if ($notice->getProfile()->hasRole(Profile_role::DELETED)) {
65 // Don't emit notices if the notice author is (being) deleted
69 $act = new Activity();
70 $act->type = ActivityObject::ACTIVITY;
71 $act->verb = ActivityVerb::DELETE;
73 $act->id = self::newUri($actor, $notice);
75 $act->content = sprintf(_m('<a href="%1$s">%2$s</a> deleted notice <a href="%3$s">{{%4$s}}</a>.'),
76 htmlspecialchars($actor->getUrl()),
77 htmlspecialchars($actor->getBestName()),
78 htmlspecialchars($notice->getUrl()),
79 htmlspecialchars($notice->getUri())
82 $act->actor = $actor->asActivityObject();
83 $act->target = new ActivityObject(); // We don't save the notice object, as it's supposed to be removed!
84 $act->target->id = $notice->getUri();
85 $act->objects = array(clone($act->target));
87 $url = $notice->getUrl();
88 $act->selfLink = $url;
89 $act->editLink = $url;
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);
99 static public function fromStored(Notice $stored)
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);
110 public function getActor()
112 return Profile::getByID($this->profile_id);
115 public function getActorObject()
117 return $this->getActor()->asActivityObject();
120 static public function getObjectType()
125 protected $_stored = array();
127 public function getStored()
129 $uri = $this->getTargetUri();
130 if (!isset($this->_stored[$uri])) {
131 $stored = new Notice();
133 if (!$stored->find(true)) {
134 throw new NoResultException($stored);
136 $this->_stored[$uri] = $stored;
138 return $this->_stored[$uri];
141 public function getTargetUri()
143 return $this->act_uri;
146 public function getUri()
151 public function asActivityObject(Profile $scoped=null)
153 $actobj = new ActivityObject();
154 $actobj->id = $this->getUri();
155 $actobj->type = ActivityObject::ACTIVITY;
156 $actobj->actor = $this->getActorObject();
157 $actobj->target = new ActivityObject();
158 $actobj->target->id = $this->getTargetUri();
159 $actobj->objects = array(clone($actobj->target));
160 $actobj->verb = ActivityVerb::DELETE;
161 $actobj->title = ActivityUtils::verbToTitle($actobj->verb);
163 $actor = $this->getActor();
164 $actobj->content = sprintf(_m('<a href="%1$s">%2$s</a> deleted notice {{%3$s}}.'),
165 htmlspecialchars($actor->getUrl()),
166 htmlspecialchars($actor->getBestName()),
167 htmlspecialchars($this->getTargetUri())
173 static public function extendActivity(Notice $stored, Activity $act, Profile $scoped=null)
175 // the original notice is deleted, but we have stored some important data
176 $object = self::fromStored($stored);
178 $act->target = new ActivityObject();
179 $act->target->id = $object->getTargetUri();
180 $act->objects = array(clone($act->target));
182 $act->context->replyToID = $object->getTargetUri();
183 $act->title = ActivityUtils::verbToTitle($act->verb);
186 static function newUri(Profile $actor, Managed_DataObject $object, $created=null)
188 if (is_null($created)) {
189 $created = common_sql_now();
191 return TagURI::mint(strtolower(get_called_class()).':%d:%s:%d:%s',
193 ActivityUtils::resolveUri($object->getObjectType(), true),
195 common_date_iso8601($created));
198 static public function beforeSchemaUpdate()
200 $table = strtolower(get_called_class());
201 $schema = Schema::get();
202 $schemadef = $schema->getTableDef($table);
204 // 2015-10-03 We change the meaning of the 'uri' field and move its
205 // content to the 'act_uri' for the deleted activity. act_created is
207 if (isset($schemadef['fields']['act_uri'])) {
208 // We already have the act_uri field, so no need to migrate to it.
211 echo "\nFound old $table table, upgrading it to contain 'act_uri' and 'act_created' field...";
213 $schemadef['fields']['act_uri'] = array('type' => 'varchar', 'not null' => true, 'length' => 191, 'description' => 'URI of the deleted notice');
214 $schemadef['fields']['act_created'] = array('type' => 'datetime', 'not null' => true, 'description' => 'datetime the notice record was created');
215 unset($schemadef['unique keys']);
216 $schema->ensureTable($table, $schemadef);
218 $deleted = new Deleted_notice();
219 $result = $deleted->find();
220 if ($result === false) {
221 print "\nFound no deleted_notice entries, continuing...";
224 print "\nFound $result deleted_notice entries, aligning with new database layout: ";
225 while($deleted->fetch()) {
226 $orig = clone($deleted);
227 $deleted->act_uri = $deleted->uri;
228 // this is a fake URI just to have something to put there to avoid NULL. crc32 of uri is to avoid collisions
229 $deleted->uri = TagURI::mint(strtolower(get_called_class()).':%d:%s:%s:%s:crc32=%x',
230 $deleted->profile_id,
231 ActivityUtils::resolveUri(self::getObjectType(), true),
233 common_date_iso8601($deleted->created),
234 crc32($deleted->act_uri)
236 $deleted->act_created = $deleted->created; // we don't actually know when the notice was created
237 $deleted->updateWithKeys($orig, 'id');
241 print "Resuming core schema upgrade...";