12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302 |
- <?php
- // This file is part of GNU social - https://www.gnu.org/software/social
- //
- // GNU social is free software: you can redistribute it and/or modify
- // it under the terms of the GNU Affero General Public License as published by
- // the Free Software Foundation, either version 3 of the License, or
- // (at your option) any later version.
- //
- // GNU social is distributed in the hope that it will be useful,
- // but WITHOUT ANY WARRANTY; without even the implied warranty of
- // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- // GNU Affero General Public License for more details.
- //
- // You should have received a copy of the GNU Affero General Public License
- // along with GNU social. If not, see <http://www.gnu.org/licenses/>.
- /**
- * @category Notices
- * @package GNUsocial
- * @author Brenda Wallace <shiny@cpan.org>
- * @author Christopher Vollick <psycotica0@gmail.com>
- * @author CiaranG <ciaran@ciarang.com>
- * @author Craig Andrews <candrews@integralblue.com>
- * @author Evan Prodromou <evan@controlezvous.ca>
- * @author Gina Haeussge <osd@foosel.net>
- * @author Jeffery To <jeffery.to@gmail.com>
- * @author Mike Cochrane <mikec@mikenz.geek.nz>
- * @author Robin Millette <millette@controlyourself.ca>
- * @author Sarven Capadisli <csarven@controlyourself.ca>
- * @author Tom Adams <tom@holizz.com>
- * @author Mikael Nordfeldth <mmn@hethane.se>
- * @copyright 2009 Free Software Foundation, Inc http://www.fsf.org
- * @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
- */
- defined('GNUSOCIAL') || die();
- /**
- * Table Definition for notice
- */
- /* We keep 200 notices, the max number of notices available per API request,
- * in the memcached cache. */
- define('NOTICE_CACHE_WINDOW', CachingNoticeStream::CACHE_WINDOW);
- define('MAX_BOXCARS', 128);
- class Notice extends Managed_DataObject
- {
- ###START_AUTOCODE
- /* the code below is auto generated do not remove the above tag */
- public $__table = 'notice'; // table name
- public $id; // int(4) primary_key not_null
- public $profile_id; // int(4) multiple_key not_null
- public $uri; // varchar(191) unique_key not 255 because utf8mb4 takes more space
- public $content; // text
- public $rendered; // text
- public $url; // text
- public $created; // datetime() multiple_key
- public $modified; // timestamp() not_null default_CURRENT_TIMESTAMP
- public $reply_to; // int(4)
- public $is_local; // int(4)
- public $source; // varchar(32)
- public $conversation; // int(4)
- public $repeat_of; // int(4)
- public $verb; // varchar(191) not 255 because utf8mb4 takes more space
- public $object_type; // varchar(191) not 255 because utf8mb4 takes more space
- public $scope; // int(4)
- /* the code above is auto generated do not remove the tag below */
- ###END_AUTOCODE
- public static function schemaDef()
- {
- $def = array(
- 'fields' => array(
- 'id' => array('type' => 'serial', 'not null' => true, 'description' => 'unique identifier'),
- 'profile_id' => array('type' => 'int', 'not null' => true, 'description' => 'who made the update'),
- 'uri' => array('type' => 'varchar', 'length' => 191, 'description' => 'universally unique identifier, usually a tag URI'),
- 'content' => array('type' => 'text', 'description' => 'update content', 'collate' => 'utf8_general_ci'),
- 'rendered' => array('type' => 'text', 'description' => 'HTML version of the content'),
- 'url' => array('type' => 'text', 'description' => 'URL of any attachment (image, video, bookmark, whatever)'),
- 'created' => array('type' => 'datetime', 'description' => 'date this record was created'),
- 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'),
- 'reply_to' => array('type' => 'int', 'description' => 'notice replied to (usually a guess)'),
- 'is_local' => array('type' => 'int', 'size' => 'tiny', 'default' => 0, 'description' => 'notice was generated by a user'),
- 'source' => array('type' => 'varchar', 'length' => 32, 'description' => 'source of comment, like "web", "im", or "clientname"'),
- 'conversation' => array('type' => 'int', 'description' => 'the local numerical conversation id'),
- 'repeat_of' => array('type' => 'int', 'description' => 'notice this is a repeat of'),
- 'object_type' => array('type' => 'varchar', 'length' => 191, 'description' => 'URI representing activity streams object type', 'default' => null),
- 'verb' => array('type' => 'varchar', 'length' => 191, 'description' => 'URI representing activity streams verb', 'default' => 'http://activitystrea.ms/schema/1.0/post'),
- 'scope' => array('type' => 'int',
- 'description' => 'bit map for distribution scope; 0 = everywhere; 1 = this server only; 2 = addressees; 4 = groups; 8 = followers; 16 = messages; null = default'),
- ),
- 'primary key' => array('id'),
- 'unique keys' => array(
- 'notice_uri_key' => array('uri'),
- ),
- 'foreign keys' => array(
- 'notice_profile_id_fkey' => array('profile', array('profile_id' => 'id')),
- 'notice_reply_to_fkey' => array('notice', array('reply_to' => 'id')),
- 'notice_conversation_fkey' => array('conversation', array('conversation' => 'id')), # note... used to refer to notice.id
- 'notice_repeat_of_fkey' => array('notice', array('repeat_of' => 'id')), # @fixme: what about repeats of deleted notices?
- ),
- 'indexes' => array(
- 'notice_is_local_created_id_idx' => array('is_local', 'created', 'id'),
- 'notice_profile_id_created_id_idx' => array('profile_id', 'created', 'id'),
- 'notice_profile_id_verb_scope_created_id_idx' => array('profile_id', 'verb', 'scope', 'created', 'id'),
- 'notice_is_local_created_profile_id_idx' => array('is_local', 'created', 'profile_id'),
- 'notice_repeat_of_created_id_idx' => array('repeat_of', 'created', 'id'),
- 'notice_conversation_created_id_idx' => array('conversation', 'created', 'id'),
- 'notice_object_type_idx' => array('object_type'),
- 'notice_verb_idx' => array('verb'),
- 'notice_url_idx' => array(array('url', 191)), // Qvitter wants this
- 'notice_reply_to_idx' => array('reply_to')
- ),
- 'fulltext indexes' => array(
- 'notice_fulltext_idx' => array('content'),
- ),
- );
- return $def;
- }
- /* Notice types */
- const LOCAL_PUBLIC = 1;
- const REMOTE = 0;
- const LOCAL_NONPUBLIC = -1;
- const GATEWAY = -2;
- const PUBLIC_SCOPE = 0; // Useful fake constant
- const SITE_SCOPE = 1;
- const ADDRESSEE_SCOPE = 2;
- const GROUP_SCOPE = 4;
- const FOLLOWER_SCOPE = 8;
- const MESSAGE_SCOPE = 16;
- protected $_profile = array();
- /**
- * Will always return a profile, if anything fails it will
- * (through _setProfile) throw a NoProfileException.
- */
- public function getProfile()
- {
- if (!isset($this->_profile[$this->profile_id])) {
- // We could've sent getKV directly to _setProfile, but occasionally we get
- // a "false" (instead of null), likely because it indicates a cache miss.
- $profile = Profile::getKV('id', $this->profile_id);
- $this->_setProfile($profile instanceof Profile ? $profile : null);
- }
- return $this->_profile[$this->profile_id];
- }
- public function _setProfile(Profile $profile=null)
- {
- if (!$profile instanceof Profile) {
- throw new NoProfileException($this->profile_id);
- }
- $this->_profile[$this->profile_id] = $profile;
- }
- public function deleteAs(Profile $actor, $delete_event=true)
- {
- if (!$this->getProfile()->sameAs($actor) && !$actor->hasRight(Right::DELETEOTHERSNOTICE)) {
- throw new AuthorizationException(_('You are not allowed to delete another user\'s notice.'));
- }
- $result = null;
- if (!$delete_event || Event::handle('DeleteNoticeAsProfile', array($this, $actor, &$result))) {
- // If $delete_event is true, we run the event. If the Event then
- // returns false it is assumed everything was handled properly
- // and the notice was deleted.
- $result = $this->delete();
- }
- return $result;
- }
- protected function deleteRelated()
- {
- if (Event::handle('NoticeDeleteRelated', array($this))) {
- // Clear related records
- $this->clearReplies();
- $this->clearLocation();
- $this->clearPrefs();
- $this->clearRepeats();
- $this->clearTags();
- $this->clearGroupInboxes();
- $this->clearFiles();
- $this->clearAttentions();
- // NOTE: we don't clear queue items
- }
- }
- public function delete($useWhere=false)
- {
- $this->deleteRelated();
- $result = parent::delete($useWhere);
- $this->blowOnDelete();
- return $result;
- }
- public function getUri()
- {
- return $this->uri;
- }
- /*
- * Get a Notice object by URI. Will call external plugins for help
- * using the event StartGetNoticeFromURI.
- *
- * @param string $uri A unique identifier for a resource (notice in this case)
- */
- public static function fromUri($uri)
- {
- $notice = null;
- if (Event::handle('StartGetNoticeFromUri', array($uri, &$notice))) {
- $notice = Notice::getKV('uri', $uri);
- Event::handle('EndGetNoticeFromUri', array($uri, $notice));
- }
- if (!$notice instanceof Notice) {
- throw new UnknownUriException($uri);
- }
- return $notice;
- }
- /*
- * @param $root boolean If true, link to just the conversation root.
- *
- * @return URL to conversation
- */
- public function getConversationUrl($anchor=true)
- {
- return Conversation::getUrlFromNotice($this, $anchor);
- }
- /*
- * Get the local representation URL of this notice.
- */
- public function getLocalUrl()
- {
- return common_local_url('shownotice', array('notice' => $this->id), null, null, false);
- }
- public function getTitle($imply=true)
- {
- $title = null;
- if (Event::handle('GetNoticeTitle', array($this, &$title)) && $imply) {
- // TRANS: Title of a notice posted without a title value.
- // TRANS: %1$s is a user name, %2$s is the notice creation date/time.
- $title = sprintf(
- _('%1$s\'s status on %2$s'),
- $this->getProfile()->getFancyName(),
- common_exact_date($this->created)
- );
- }
- return $title;
- }
- public function getContent()
- {
- return $this->content;
- }
- public function getRendered()
- {
- // we test $this->id because if it's not inserted yet, we can't update the field
- if (!empty($this->id) && (is_null($this->rendered) || $this->rendered === '')) {
- // update to include rendered content on-the-fly, so we don't have to have a fix-up script in upgrade.php
- common_debug('Rendering notice '.$this->getID().' as it had no rendered HTML content.');
- $orig = clone($this);
- $this->rendered = common_render_content(
- $this->getContent(),
- $this->getProfile(),
- ($this->hasParent() ? $this->getParent() : null)
- );
- $this->update($orig);
- }
- return $this->rendered;
- }
- public function getCreated()
- {
- return $this->created;
- }
- public function getVerb($make_relative=false)
- {
- return ActivityUtils::resolveUri($this->verb, $make_relative);
- }
- public function isVerb(array $verbs)
- {
- return ActivityUtils::compareVerbs($this->getVerb(), $verbs);
- }
- /*
- * Get the original representation URL of this notice.
- *
- * @param boolean $fallback Whether to fall back to generate a local URL or throw InvalidUrlException
- */
- public function getUrl($fallback=false)
- {
- // The risk is we start having empty urls and non-http uris...
- // and we can't really handle any other protocol right now.
- switch (true) {
- case $this->isLocal():
- return common_local_url('shownotice', array('notice' => $this->getID()), null, null, false);
- case common_valid_http_url($this->url): // should we allow non-http/https URLs?
- return $this->url;
- case common_valid_http_url($this->uri): // Sometimes we only have the URI for remote posts.
- return $this->uri;
- case $fallback:
- // let's generate a valid link to our locally available notice on demand
- return common_local_url('shownotice', array('notice' => $this->getID()), null, null, false);
- default:
- throw new InvalidUrlException($this->url);
- }
- }
- public function getSelfLink()
- {
- if ($this->isLocal()) {
- return common_local_url('ApiStatusesShow', array('id' => $this->getID(), 'format' => 'atom'));
- }
- $selfLink = $this->getPref('ostatus', 'self');
- if (!common_valid_http_url($selfLink)) {
- throw new InvalidUrlException($selfLink);
- }
- return $selfLink;
- }
- public function getObjectType($canonical = false)
- {
- if (is_null($this->object_type) || $this->object_type==='') {
- throw new NoObjectTypeException($this);
- }
- return ActivityUtils::resolveUri($this->object_type, $canonical);
- }
- public function isObjectType(array $types)
- {
- try {
- return ActivityUtils::compareTypes($this->getObjectType(), $types);
- } catch (NoObjectTypeException $e) {
- return false;
- }
- }
- /**
- * Extract #hashtags from this notice's content and save them to the database.
- */
- public function saveTags()
- {
- /* extract all #hastags */
- $count = preg_match_all('/(?:^|\s)#([\pL\pN_\-\.]{1,64})/u', strtolower($this->content), $match);
- if (!$count) {
- return true;
- }
- /* Add them to the database */
- return $this->saveKnownTags($match[1]);
- }
- /**
- * Record the given set of hash tags in the db for this notice.
- * Given tag strings will be normalized and checked for dupes.
- */
- public function saveKnownTags($hashtags)
- {
- //turn each into their canonical tag
- //this is needed to remove dupes before saving e.g. #hash.tag = #hashtag
- for ($i = 0; $i < count($hashtags); ++$i) {
- /* elide characters we don't want in the tag */
- $hashtags[$i] = common_canonical_tag($hashtags[$i]);
- }
- foreach (array_unique($hashtags) as $hashtag) {
- $this->saveTag($hashtag);
- self::blow('profile:notice_ids_tagged:%d:%s', $this->profile_id, $hashtag);
- }
- return true;
- }
- /**
- * Record a single hash tag as associated with this notice.
- * Tag format and uniqueness must be validated by caller.
- */
- public function saveTag($hashtag)
- {
- $tag = new Notice_tag();
- $tag->notice_id = $this->id;
- $tag->tag = $hashtag;
- $tag->created = $this->created;
- $id = $tag->insert();
- if (!$id) {
- // TRANS: Server exception. %s are the error details.
- throw new ServerException(sprintf(
- _('Database error inserting hashtag: %s.'),
- $last_error->message
- ));
- return;
- }
- // if it's saved, blow its cache
- $tag->blowCache(false);
- }
- /**
- * Save a new notice and push it out to subscribers' inboxes.
- * Poster's permissions are checked before sending.
- *
- * @param int $profile_id Profile ID of the poster
- * @param string $content source message text; links may be shortened
- * per current user's preference
- * @param string $source source key ('web', 'api', etc)
- * @param array $options Associative array of optional properties:
- * string 'created' timestamp of notice; defaults to now
- * int 'is_local' source/gateway ID, one of:
- * Notice::LOCAL_PUBLIC - Local, ok to appear in public timeline
- * Notice::REMOTE - Sent from a remote service;
- * hide from public timeline but show in
- * local "and friends" timelines
- * Notice::LOCAL_NONPUBLIC - Local, but hide from public timeline
- * Notice::GATEWAY - From another non-OStatus service;
- * will not appear in public views
- * float 'lat' decimal latitude for geolocation
- * float 'lon' decimal longitude for geolocation
- * int 'location_id' geoname identifier
- * int 'location_ns' geoname namespace to interpret location_id
- * int 'reply_to'; notice ID this is a reply to
- * int 'repeat_of'; notice ID this is a repeat of
- * string 'uri' unique ID for notice; a unique tag uri (can be url or anything too)
- * string 'url' permalink to notice; defaults to local notice URL
- * string 'rendered' rendered HTML version of content
- * array 'replies' list of profile URIs for reply delivery in
- * place of extracting @-replies from content.
- * array 'groups' list of group IDs to deliver to, in place of
- * extracting ! tags from content
- * array 'tags' list of hashtag strings to save with the notice
- * in place of extracting # tags from content
- * array 'urls' list of attached/referred URLs to save with the
- * notice in place of extracting links from content
- * boolean 'distribute' whether to distribute the notice, default true
- * string 'object_type' URL of the associated object type (default ActivityObject::NOTE)
- * string 'verb' URL of the associated verb (default ActivityVerb::POST)
- * int 'scope' Scope bitmask; default to SITE_SCOPE on private sites, 0 otherwise
- *
- * @fixme tag override
- *
- * @return Notice
- * @throws ClientException
- */
- public static function saveNew($profile_id, $content, $source, array $options = null)
- {
- $defaults = array('uri' => null,
- 'url' => null,
- 'self' => null,
- 'conversation' => null, // URI of conversation
- 'reply_to' => null, // This will override convo URI if the parent is known
- 'repeat_of' => null, // This will override convo URI if the repeated notice is known
- 'scope' => null,
- 'distribute' => true,
- 'object_type' => null,
- 'verb' => null);
- if (!empty($options) && is_array($options)) {
- $options = array_merge($defaults, $options);
- extract($options);
- } else {
- extract($defaults);
- }
- if (!isset($is_local)) {
- $is_local = Notice::LOCAL_PUBLIC;
- }
- $profile = Profile::getKV('id', $profile_id);
- if (!$profile instanceof Profile) {
- // TRANS: Client exception thrown when trying to save a notice for an unknown user.
- throw new ClientException(_('Problem saving notice. Unknown user.'));
- }
- $user = User::getKV('id', $profile_id);
- if ($user instanceof User) {
- // Use the local user's shortening preferences, if applicable.
- $final = $user->shortenLinks($content);
- } else {
- $final = common_shorten_links($content);
- }
- if (Notice::contentTooLong($final)) {
- // TRANS: Client exception thrown if a notice contains too many characters.
- throw new ClientException(_('Problem saving notice. Too long.'));
- }
- if (common_config('throttle', 'enabled') && !Notice::checkEditThrottle($profile_id)) {
- common_log(LOG_WARNING, 'Excessive posting by profile #' . $profile_id . '; throttled.');
- // TRANS: Client exception thrown when a user tries to post too many notices in a given time frame.
- throw new ClientException(_('Too many notices too fast; take a breather '.
- 'and post again in a few minutes.'));
- }
- if (common_config('site', 'dupelimit') > 0 && !Notice::checkDupes($profile_id, $final)) {
- common_log(LOG_WARNING, 'Dupe posting by profile #' . $profile_id . '; throttled.');
- // TRANS: Client exception thrown when a user tries to post too many duplicate notices in a given time frame.
- throw new ClientException(_('Too many duplicate messages too quickly;'.
- ' take a breather and post again in a few minutes.'));
- }
- if (!$profile->hasRight(Right::NEWNOTICE)) {
- common_log(LOG_WARNING, "Attempted post from user disallowed to post: " . $profile->nickname);
- // TRANS: Client exception thrown when a user tries to post while being banned.
- throw new ClientException(_('You are banned from posting notices on this site.'), 403);
- }
- $notice = new Notice();
- $notice->profile_id = $profile_id;
- if ($source && in_array($source, common_config('public', 'autosource'))) {
- $notice->is_local = Notice::LOCAL_NONPUBLIC;
- } else {
- $notice->is_local = $is_local;
- }
- if (!empty($created)) {
- $notice->created = $created;
- } else {
- $notice->created = common_sql_now();
- }
- if (!$notice->isLocal()) {
- // Only do these checks for non-local notices. Local notices will generate these values later.
- if (empty($uri)) {
- throw new ServerException('No URI for remote notice. Cannot accept that.');
- }
- }
- $notice->content = $final;
- $notice->source = $source;
- $notice->uri = $uri;
- $notice->url = $url;
- // Get the groups here so we can figure out replies and such
- if (!isset($groups)) {
- $groups = User_group::idsFromText($notice->content, $profile);
- }
- $reply = null;
- // Handle repeat case
- if (!empty($options['repeat_of'])) {
- // Check for a private one
- $repeat = Notice::getByID($options['repeat_of']);
- if ($profile->sameAs($repeat->getProfile())) {
- // TRANS: Client error displayed when trying to repeat an own notice.
- throw new ClientException(_('You cannot repeat your own notice.'));
- }
- if ($repeat->scope != Notice::SITE_SCOPE &&
- $repeat->scope != Notice::PUBLIC_SCOPE) {
- // TRANS: Client error displayed when trying to repeat a non-public notice.
- throw new ClientException(_('Cannot repeat a private notice.'), 403);
- }
- if (!$repeat->inScope($profile)) {
- // The generic checks above should cover this, but let's be sure!
- // TRANS: Client error displayed when trying to repeat a notice you cannot access.
- throw new ClientException(_('Cannot repeat a notice you cannot read.'), 403);
- }
- if ($profile->hasRepeated($repeat)) {
- // TRANS: Client error displayed when trying to repeat an already repeated notice.
- throw new ClientException(_('You already repeated that notice.'));
- }
- $notice->repeat_of = $repeat->id;
- $notice->conversation = $repeat->conversation;
- } else {
- $reply = null;
- // If $reply_to is specified, we check that it exists, and then
- // return it if it does
- if (!empty($reply_to)) {
- $reply = Notice::getKV('id', $reply_to);
- } elseif (in_array($source, array('xmpp', 'mail', 'sms'))) {
- // If the source lacks capability of sending the "reply_to"
- // metadata, let's try to find an inline replyto-reference.
- $reply = self::getInlineReplyTo($profile, $final);
- }
- if ($reply instanceof Notice) {
- if (!$reply->inScope($profile)) {
- // TRANS: Client error displayed when trying to reply to a notice a the target has no access to.
- // TRANS: %1$s is a user nickname, %2$d is a notice ID (number).
- throw new ClientException(sprintf(
- _('%1$s has no access to notice %2$d.'),
- $profile->nickname,
- $reply->id
- ), 403);
- }
- // If it's a repeat, the reply_to should be to the original
- if ($reply->isRepeat()) {
- $notice->reply_to = $reply->repeat_of;
- } else {
- $notice->reply_to = $reply->id;
- }
- // But the conversation ought to be the same :)
- $notice->conversation = $reply->conversation;
- // If the original is private to a group, and notice has
- // no group specified, make it to the same group(s)
- if (empty($groups) && ($reply->scope & Notice::GROUP_SCOPE)) {
- $groups = array();
- $replyGroups = $reply->getGroups();
- foreach ($replyGroups as $group) {
- if ($profile->isMember($group)) {
- $groups[] = $group->id;
- }
- }
- }
- // Scope set below
- }
- // If we don't know the reply, we might know the conversation!
- // This will happen if a known remote user replies to an
- // unknown remote user - within a known conversation.
- if (empty($notice->conversation) and !empty($options['conversation'])) {
- $conv = Conversation::getKV('uri', $options['conversation']);
- if ($conv instanceof Conversation) {
- common_debug('Conversation stitched together from (probably) a reply to unknown remote user. Activity creation time ('.$notice->created.') should maybe be compared to conversation creation time ('.$conv->created.').');
- } else {
- // Conversation entry with specified URI was not found, so we must create it.
- common_debug('Conversation URI not found, so we will create it with the URI given in the options to Notice::saveNew: '.$options['conversation']);
- $convctx = new ActivityContext();
- $convctx->conversation = $options['conversation'];
- if (array_key_exists('conversation_url', $options)) {
- $convctx->conversation_url = $options['conversation_url'];
- }
- // The insert in Conversation::create throws exception on failure
- $conv = Conversation::create($convctx, $notice->created);
- }
- $notice->conversation = $conv->getID();
- unset($conv);
- }
- }
- // If it's not part of a conversation, it's the beginning of a new conversation.
- if (empty($notice->conversation)) {
- $conv = Conversation::create();
- $notice->conversation = $conv->getID();
- unset($conv);
- }
- $notloc = new Notice_location();
- if (!empty($lat) && !empty($lon)) {
- $notloc->lat = $lat;
- $notloc->lon = $lon;
- }
- if (!empty($location_ns) && !empty($location_id)) {
- $notloc->location_id = $location_id;
- $notloc->location_ns = $location_ns;
- }
- if (!empty($rendered)) {
- $notice->rendered = $rendered;
- } else {
- $notice->rendered = common_render_content(
- $final,
- $notice->getProfile(),
- ($notice->hasParent() ? $notice->getParent() : null)
- );
- }
- if (empty($verb)) {
- if ($notice->isRepeat()) {
- $notice->verb = ActivityVerb::SHARE;
- $notice->object_type = ActivityObject::ACTIVITY;
- } else {
- $notice->verb = ActivityVerb::POST;
- }
- } else {
- $notice->verb = $verb;
- }
- if (empty($object_type)) {
- $notice->object_type = (empty($notice->reply_to)) ? ActivityObject::NOTE : ActivityObject::COMMENT;
- } else {
- $notice->object_type = $object_type;
- }
- if (is_null($scope) && $reply instanceof Notice) {
- $notice->scope = $reply->scope;
- } else {
- $notice->scope = $scope;
- }
- $notice->scope = self::figureOutScope($profile, $groups, $notice->scope);
- if (Event::handle('StartNoticeSave', array(&$notice))) {
- // XXX: some of these functions write to the DB
- try {
- $notice->insert(); // throws exception on failure, if successful we have an ->id
- if (($notloc->lat && $notloc->lon) || ($notloc->location_id && $notloc->location_ns)) {
- $notloc->notice_id = $notice->getID();
- $notloc->insert(); // store the notice location if it had any information
- }
- } catch (Exception $e) {
- // Let's test if we managed initial insert, which would imply
- // failing on some update-part (check 'insert()'). Delete if
- // something had been stored to the database.
- if (!empty($notice->id)) {
- $notice->delete();
- }
- throw $e;
- }
- }
- if ($self && common_valid_http_url($self)) {
- $notice->setPref('ostatus', 'self', $self);
- }
- // Only save 'attention' and metadata stuff (URLs, tags...) stuff if
- // the activityverb is a POST (since stuff like repeat, favorite etc.
- // reasonably handle notifications themselves.
- if (ActivityUtils::compareVerbs($notice->verb, array(ActivityVerb::POST))) {
- if (isset($replies)) {
- $notice->saveKnownReplies($replies);
- } else {
- $notice->saveReplies();
- }
- if (isset($tags)) {
- $notice->saveKnownTags($tags);
- } else {
- $notice->saveTags();
- }
- // Note: groups may save tags, so must be run after tags are saved
- // to avoid errors on duplicates.
- // Note: groups should always be set.
- $notice->saveKnownGroups($groups);
- if (isset($urls)) {
- $notice->saveKnownUrls($urls);
- } else {
- $notice->saveUrls();
- }
- }
- if ($distribute) {
- // Prepare inbox delivery, may be queued to background.
- $notice->distribute();
- }
- return $notice;
- }
- public static function saveActivity(Activity $act, Profile $actor, array $options = [])
- {
- // First check if we're going to let this Activity through from the specific actor
- if (!$actor->hasRight(Right::NEWNOTICE)) {
- common_log(LOG_WARNING, "Attempted post from user disallowed to post: " . $actor->getNickname());
- // TRANS: Client exception thrown when a user tries to post while being banned.
- throw new ClientException(_m('You are banned from posting notices on this site.'), 403);
- }
- if (common_config('throttle', 'enabled') && !self::checkEditThrottle($actor->id)) {
- common_log(LOG_WARNING, 'Excessive posting by profile #' . $actor->id . '; throttled.');
- // TRANS: Client exception thrown when a user tries to post too many notices in a given time frame.
- throw new ClientException(_m('Too many notices too fast; take a breather '.
- 'and post again in a few minutes.'));
- }
- // Get ActivityObject properties
- $actobj = null;
- if (!empty($act->id)) {
- // implied object
- $options['uri'] = $act->id;
- $options['url'] = $act->link;
- if ($act->selfLink) {
- $options['self'] = $act->selfLink;
- }
- } else {
- $actobj = count($act->objects)===1 ? $act->objects[0] : null;
- if (!is_null($actobj) && !empty($actobj->id)) {
- $options['uri'] = $actobj->id;
- if ($actobj->link) {
- $options['url'] = $actobj->link;
- } elseif (preg_match('!^https?://!', $actobj->id)) {
- $options['url'] = $actobj->id;
- }
- }
- if ($actobj->selfLink) {
- $options['self'] = $actobj->selfLink;
- }
- }
- $defaults = array(
- 'groups' => array(),
- 'is_local' => $actor->isLocal() ? self::LOCAL_PUBLIC : self::REMOTE,
- 'mentions' => array(),
- 'reply_to' => null,
- 'repeat_of' => null,
- 'scope' => null,
- 'self' => null,
- 'source' => 'unknown',
- 'tags' => array(),
- 'uri' => null,
- 'url' => null,
- 'urls' => array(),
- 'distribute' => true);
- // options will have default values when nothing has been supplied
- $options = array_merge($defaults, $options);
- foreach (array_keys($defaults) as $key) {
- // Only convert the keynames we specify ourselves from 'defaults' array into variables
- $$key = $options[$key];
- }
- extract($options, EXTR_SKIP);
- // dupe check
- $stored = new Notice();
- if (!empty($uri) && !ActivityUtils::compareVerbs($act->verb, array(ActivityVerb::DELETE))) {
- $stored->uri = $uri;
- if ($stored->find()) {
- common_debug('cannot create duplicate Notice URI: '.$stored->uri);
- // I _assume_ saving a Notice with a colliding URI means we're really trying to
- // save the same notice again...
- throw new AlreadyFulfilledException('Notice URI already exists');
- }
- }
- // NOTE: Sandboxed users previously got all the notices _during_
- // sandbox period set to to is_local=Notice::LOCAL_NONPUBLIC here.
- // Since then we have started just filtering _when_ it gets shown
- // instead of creating a mixed jumble of differently scoped notices.
- if ($source && in_array($source, common_config('public', 'autosource'))) {
- $stored->is_local = Notice::LOCAL_NONPUBLIC;
- } else {
- $stored->is_local = intval($is_local);
- }
- if (!$stored->isLocal()) {
- // Only do these checks for non-local notices. Local notices will generate these values later.
- if (!common_valid_http_url($url)) {
- common_debug('Bad notice URL: ['.$url.'], URI: ['.$uri.']. Cannot link back to original! This is normal for shared notices etc.');
- }
- if (empty($uri)) {
- throw new ServerException('No URI for remote notice. Cannot accept that.');
- }
- }
- $stored->profile_id = $actor->getID();
- $stored->source = $source;
- $stored->uri = $uri;
- $stored->url = $url;
- $stored->verb = $act->verb;
- // we use mb_strlen because it _might_ be that the content is just the string "0"...
- $content = mb_strlen($act->content) ? $act->content : $act->summary;
- if (mb_strlen($content)===0 && !is_null($actobj)) {
- $content = mb_strlen($actobj->content) ? $actobj->content : $actobj->summary;
- }
- // Strip out any bad HTML from $content. URI.Base is used to sort out relative URLs.
- $stored->rendered = common_purify($content, ['URI.Base' => $stored->url ?: null]);
- $stored->content = common_strip_html($stored->getRendered(), true, true);
- if (trim($stored->content) === '') {
- // TRANS: Error message when the plain text content of a notice has zero length.
- throw new ClientException(_('Empty notice content, will not save this.'));
- }
- unset($content); // garbage collect
- // Maybe a missing act-time should be fatal if the actor is not local?
- if (!empty($act->time)) {
- $stored->created = common_sql_date($act->time);
- } else {
- $stored->created = common_sql_now();
- }
- $reply = null; // this will store the in-reply-to Notice if found
- $replyUris = []; // this keeps a list of possible URIs to look up
- if ($act->context instanceof ActivityContext && !empty($act->context->replyToID)) {
- $replyUris[] = $act->context->replyToID;
- }
- if ($act->target instanceof ActivityObject && !empty($act->target->id)) {
- $replyUris[] = $act->target->id;
- }
- foreach (array_unique($replyUris) as $replyUri) {
- $reply = self::getKV('uri', $replyUri);
- // Only do remote fetching if we're not a private site
- if (!common_config('site', 'private') && !$reply instanceof Notice) {
- // the URI is the object we're looking for, $actor is a
- // Profile that surely knows of it and &$reply where it
- // will be stored when fetched
- Event::handle('FetchRemoteNotice', array($replyUri, $actor, &$reply));
- }
- // we got what we're in-reply-to now, so let's move on
- if ($reply instanceof Notice) {
- break;
- }
- // otherwise reset whatever we might've gotten from the event
- $reply = null;
- }
- unset($replyUris); // garbage collect
- if ($reply instanceof Notice) {
- if (!$reply->inScope($actor)) {
- // TRANS: Client error displayed when trying to reply to a notice a the target has no access to.
- // TRANS: %1$s is a user nickname, %2$d is a notice ID (number).
- throw new ClientException(sprintf(_m('%1$s has no right to reply to notice %2$d.'), $actor->getNickname(), $reply->id), 403);
- }
- $stored->reply_to = $reply->id;
- $stored->conversation = $reply->conversation;
- // If the original is private to a group, and notice has no group specified,
- // make it to the same group(s)
- if (empty($groups) && ($reply->scope & Notice::GROUP_SCOPE)) {
- $replyGroups = $reply->getGroups();
- foreach ($replyGroups as $group) {
- if ($actor->isMember($group)) {
- $groups[] = $group->id;
- }
- }
- }
- if (is_null($scope)) {
- $scope = $reply->scope;
- }
- } else {
- // If we don't know the reply, we might know the conversation!
- // This will happen if a known remote user replies to an
- // unknown remote user - within a known conversation.
- if (empty($stored->conversation) and !empty($act->context->conversation)) {
- $conv = Conversation::getKV('uri', $act->context->conversation);
- if ($conv instanceof Conversation) {
- common_debug('Conversation stitched together from (probably) a reply activity to unknown remote user. Activity creation time ('.$stored->created.') should maybe be compared to conversation creation time ('.$conv->created.').');
- } else {
- // Conversation entry with specified URI was not found, so we must create it.
- common_debug('Conversation URI not found, so we will create it with the URI given in the context of the activity: '.$act->context->conversation);
- // The insert in Conversation::create throws exception on failure
- $conv = Conversation::create($act->context, $stored->created);
- }
- $stored->conversation = $conv->getID();
- unset($conv);
- }
- }
- unset($reply); // garbage collect
- // If it's not part of a conversation, it's the beginning of a new conversation.
- if (empty($stored->conversation)) {
- $conv = Conversation::create();
- $stored->conversation = $conv->getID();
- unset($conv);
- }
- $notloc = null;
- if ($act->context instanceof ActivityContext) {
- if ($act->context->location instanceof Location) {
- $notloc = Notice_location::fromLocation($act->context->location);
- }
- } else {
- $act->context = new ActivityContext();
- }
- if (array_key_exists(ActivityContext::ATTN_PUBLIC, $act->context->attention)) {
- $stored->scope = Notice::PUBLIC_SCOPE;
- // TODO: maybe we should actually keep this? if the saveAttentions thing wants to use it...
- unset($act->context->attention[ActivityContext::ATTN_PUBLIC]);
- } else {
- $stored->scope = self::figureOutScope($actor, $groups, $scope);
- }
- foreach ($act->categories as $cat) {
- if ($cat->term) {
- $term = common_canonical_tag($cat->term);
- if (!empty($term)) {
- $tags[] = $term;
- }
- }
- }
- foreach ($act->enclosures as $href) {
- // @todo FIXME: Save these locally or....?
- $urls[] = $href;
- }
- if (ActivityUtils::compareVerbs($stored->verb, array(ActivityVerb::POST))) {
- if (empty($act->objects[0]->type)) {
- // Default type for the post verb is 'note', but we know it's
- // a 'comment' if it is in reply to something.
- $stored->object_type = empty($stored->reply_to) ? ActivityObject::NOTE : ActivityObject::COMMENT;
- } else {
- //TODO: Is it safe to always return a relative URI? The
- // JSON version of ActivityStreams always use it, so we
- // should definitely be able to handle it...
- $stored->object_type = ActivityUtils::resolveUri($act->objects[0]->type, true);
- }
- }
- if (Event::handle('StartNoticeSave', array(&$stored))) {
- // XXX: some of these functions write to the DB
- try {
- $result = $stored->insert(); // throws exception on error
- if ($notloc instanceof Notice_location) {
- $notloc->notice_id = $stored->getID();
- $notloc->insert();
- }
- $orig = clone($stored); // for updating later in this try clause
- $object = null;
- Event::handle('StoreActivityObject', array($act, $stored, $options, &$object));
- if (empty($object)) {
- throw new NoticeSaveException('Unsuccessful call to StoreActivityObject '._ve($stored->getUri()) . ': '._ve($act->asString()));
- }
- unset($object);
- // If something changed in the Notice during StoreActivityObject
- $stored->update($orig);
- } catch (Exception $e) {
- if (empty($stored->id)) {
- common_debug('Failed to save stored object entry in database ('.$e->getMessage().')');
- } else {
- common_debug('Failed to store activity object in database ('.$e->getMessage().'), deleting notice id '.$stored->id);
- $stored->delete();
- }
- throw $e;
- }
- }
- unset($notloc); // garbage collect
- if (!$stored instanceof Notice) {
- throw new ServerException('StartNoticeSave did not give back a Notice.');
- } elseif (empty($stored->id)) {
- throw new ServerException('Supposedly saved Notice has no ID.');
- }
- if ($self && common_valid_http_url($self)) {
- $stored->setPref('ostatus', 'self', $self);
- }
- if ($self && common_valid_http_url($self)) {
- $stored->setPref('ostatus', 'self', $self);
- }
- // Only save 'attention' and metadata stuff (URLs, tags...) stuff if
- // the activityverb is a POST (since stuff like repeat, favorite etc.
- // reasonably handle notifications themselves.
- if (ActivityUtils::compareVerbs($stored->verb, array(ActivityVerb::POST))) {
- if (!empty($tags)) {
- $stored->saveKnownTags($tags);
- } else {
- $stored->saveTags();
- }
- // Note: groups may save tags, so must be run after tags are saved
- // to avoid errors on duplicates.
- $stored->saveAttentions($act->context->attention);
- if (!empty($urls)) {
- $stored->saveKnownUrls($urls);
- } else {
- $stored->saveUrls();
- }
- }
- if ($distribute) {
- // Prepare inbox delivery, may be queued to background.
- $stored->distribute();
- }
- return $stored;
- }
- public static function figureOutScope(Profile $actor, array $groups, $scope = null)
- {
- $scope = is_null($scope) ? self::defaultScope() : intval($scope);
- // For private streams
- try {
- $user = $actor->getUser();
- // FIXME: We can't do bit comparison with == (Legacy StatusNet thing. Let's keep it for now.)
- if ($user->private_stream && ($scope === Notice::PUBLIC_SCOPE || $scope === Notice::SITE_SCOPE)) {
- $scope |= Notice::FOLLOWER_SCOPE;
- }
- } catch (NoSuchUserException $e) {
- // TODO: Not a local user, so we don't know about scope preferences... yet!
- }
- // Force the scope for private groups
- foreach ($groups as $group_id) {
- try {
- $group = User_group::getByID($group_id);
- if ($group->force_scope) {
- $scope |= Notice::GROUP_SCOPE;
- break;
- }
- } catch (Exception $e) {
- common_log(LOG_ERR, 'Notice figureOutScope threw exception: '.$e->getMessage());
- }
- }
- return $scope;
- }
- public function blowOnInsert($conversation = false)
- {
- $this->blowStream('profile:notice_ids:%d', $this->profile_id);
- if ($this->isPublic()) {
- $this->blowStream('public');
- $this->blowStream('networkpublic');
- }
- if ($this->conversation) {
- self::blow('notice:list-ids:conversation:%s', $this->conversation);
- self::blow('conversation:notice_count:%d', $this->conversation);
- }
- if ($this->isRepeat()) {
- // XXX: we should probably only use one of these
- $this->blowStream('notice:repeats:%d', $this->repeat_of);
- self::blow('notice:list-ids:repeat_of:%d', $this->repeat_of);
- }
- $original = Notice::getKV('id', $this->repeat_of);
- if ($original instanceof Notice) {
- $originalUser = User::getKV('id', $original->profile_id);
- if ($originalUser instanceof User) {
- $this->blowStream('user:repeats_of_me:%d', $originalUser->id);
- }
- }
- $profile = Profile::getKV($this->profile_id);
- if ($profile instanceof Profile) {
- $profile->blowNoticeCount();
- }
- $ptags = $this->getProfileTags();
- foreach ($ptags as $ptag) {
- $ptag->blowNoticeStreamCache();
- }
- }
- /**
- * Clear cache entries related to this notice at delete time.
- * Necessary to avoid breaking paging on public, profile timelines.
- */
- public function blowOnDelete()
- {
- $this->blowOnInsert();
- self::blow('profile:notice_ids:%d;last', $this->profile_id);
- if ($this->isPublic()) {
- self::blow('public;last');
- self::blow('networkpublic;last');
- }
- self::blow('fave:by_notice', $this->id);
- if ($this->conversation) {
- // In case we're the first, will need to calc a new root.
- self::blow('notice:conversation_root:%d', $this->conversation);
- }
- $ptags = $this->getProfileTags();
- foreach ($ptags as $ptag) {
- $ptag->blowNoticeStreamCache(true);
- }
- }
- public function blowStream()
- {
- $c = self::memcache();
- if (empty($c)) {
- return false;
- }
- $args = func_get_args();
- $format = array_shift($args);
- $keyPart = vsprintf($format, $args);
- $cacheKey = Cache::key($keyPart);
- $c->delete($cacheKey);
- // delete the "last" stream, too, if this notice is
- // older than the top of that stream
- $lastKey = $cacheKey.';last';
- $lastStr = $c->get($lastKey);
- if ($lastStr !== false) {
- $window = explode(',', $lastStr);
- $lastID = $window[0];
- $lastNotice = Notice::getKV('id', $lastID);
- if (!$lastNotice instanceof Notice // just weird
- || strtotime($lastNotice->created) >= strtotime($this->created)) {
- $c->delete($lastKey);
- }
- }
- }
- /** save all urls in the notice to the db
- *
- * follow redirects and save all available file information
- * (mimetype, date, size, oembed, etc.)
- *
- * @return void
- */
- public function saveUrls()
- {
- if (common_config('attachments', 'process_links')) {
- common_replace_urls_callback($this->content, array($this, 'saveUrl'), $this);
- }
- }
- /**
- * Save the given URLs as related links/attachments to the db
- *
- * follow redirects and save all available file information
- * (mimetype, date, size, oembed, etc.)
- *
- * @return void
- */
- public function saveKnownUrls($urls)
- {
- if (common_config('attachments', 'process_links')) {
- // @fixme validation?
- foreach (array_unique($urls) as $url) {
- $this->saveUrl($url, $this);
- }
- }
- }
- /**
- * @private callback
- */
- public function saveUrl($url, Notice $notice)
- {
- try {
- File::processNew($url, $notice);
- } catch (ServerException $e) {
- // Could not save URL. Log it?
- }
- }
- public static function checkDupes($profile_id, $content)
- {
- $profile = Profile::getKV($profile_id);
- if (!$profile instanceof Profile) {
- return false;
- }
- $notice = $profile->getNotices(0, CachingNoticeStream::CACHE_WINDOW);
- if (!empty($notice)) {
- $last = 0;
- while ($notice->fetch()) {
- if (time() - strtotime($notice->created) >= common_config('site', 'dupelimit')) {
- return true;
- } elseif ($notice->content === $content) {
- return false;
- }
- }
- }
- // If we get here, oldest item in cache window is not
- // old enough for dupe limit; do direct check against DB
- $notice = new Notice();
- $notice->profile_id = $profile_id;
- $notice->content = $content;
- $threshold = common_sql_date(time() - common_config('site', 'dupelimit'));
- $notice->whereAdd(sprintf("created > '%s'", $notice->escape($threshold)));
- $cnt = $notice->count();
- return ($cnt == 0);
- }
- public static function checkEditThrottle($profile_id)
- {
- $profile = Profile::getKV($profile_id);
- if (!$profile instanceof Profile) {
- return false;
- }
- // Get the Nth notice
- $notice = $profile->getNotices(common_config('throttle', 'count') - 1, 1);
- if ($notice && $notice->fetch()) {
- // If the Nth notice was posted less than timespan seconds ago
- if (time() - strtotime($notice->created) <= common_config('throttle', 'timespan')) {
- // Then we throttle
- return false;
- }
- }
- // Either not N notices in the stream, OR the Nth was not posted within timespan seconds
- return true;
- }
- protected $_attachments = [];
- public function attachments()
- {
- if (isset($this->_attachments[$this->id])) {
- return $this->_attachments[$this->id];
- }
- $f2ps = File_to_post::listGet('post_id', array($this->id));
- $ids = [];
- foreach ($f2ps[$this->id] as $f2p) {
- $ids[] = $f2p->file_id;
- }
- return $this->_setAttachments(File::multiGet('id', $ids)->fetchAll());
- }
- public function _setAttachments(array $attachments)
- {
- return $this->_attachments[$this->id] = $attachments;
- }
- public static function publicStream($offset = 0, $limit = 20, $since_id = null, $max_id = null)
- {
- $stream = new PublicNoticeStream();
- return $stream->getNotices($offset, $limit, $since_id, $max_id);
- }
- public static function conversationStream($id, $offset = 0, $limit = 20, $since_id = null, $max_id = null, Profile $scoped = null)
- {
- $stream = new ConversationNoticeStream($id, $scoped);
- return $stream->getNotices($offset, $limit, $since_id, $max_id);
- }
- /**
- * Is this notice part of an active conversation?
- *
- * @return boolean true if other messages exist in the same
- * conversation, false if this is the only one
- */
- public function hasConversation()
- {
- if (empty($this->conversation)) {
- // this notice is not part of a conversation apparently
- // FIXME: all notices should have a conversation value, right?
- return false;
- }
- //FIXME: Get the Profile::current() stuff some other way
- // to avoid confusion between queue processing and session.
- $notice = self::conversationStream($this->conversation, 1, 1, null, null, Profile::current());
- // if our "offset 1, limit 1" query got a result, return true else false
- return $notice->N > 0;
- }
- /**
- * Grab the earliest notice from this conversation.
- *
- * @return Notice or null
- */
- public function conversationRoot($profile = -1)
- {
- // XXX: can this happen?
- if (empty($this->conversation)) {
- return null;
- }
- // Get the current profile if not specified
- if (is_int($profile) && $profile == -1) {
- $profile = Profile::current();
- }
- // If this notice is out of scope, no root for you!
- if (!$this->inScope($profile)) {
- return null;
- }
- // If this isn't a reply to anything, then it's its own
- // root if it's the earliest notice in the conversation:
- if (empty($this->reply_to)) {
- $root = new Notice;
- $root->conversation = $this->conversation;
- $root->orderBy('notice.created ASC');
- $root->find(true); // true means "fetch first result"
- $root->free();
- return $root;
- }
- if (is_null($profile)) {
- $keypart = sprintf('notice:conversation_root:%d:null', $this->id);
- } else {
- $keypart = sprintf(
- 'notice:conversation_root:%d:%d',
- $this->id,
- $profile->id
- );
- }
- $root = self::cacheGet($keypart);
- if ($root !== false && $root->inScope($profile)) {
- return $root;
- }
- $last = $this;
- while (true) {
- try {
- $parent = $last->getParent();
- if ($parent->inScope($profile)) {
- $last = $parent;
- continue;
- }
- } catch (NoParentNoticeException $e) {
- // Latest notice has no parent
- } catch (NoResultException $e) {
- // Notice was not found, so we can't go further up in the tree.
- // FIXME: Maybe we should do this in a more stable way where deleted
- // notices won't break conversation chains?
- }
- // No parent, or parent out of scope
- $root = $last;
- break;
- }
- self::cacheSet($keypart, $root);
- return $root;
- }
- /**
- * Pull up a full list of local recipients who will be getting
- * this notice in their inbox. Results will be cached, so don't
- * change the input data wily-nilly!
- *
- * @param array $groups optional list of Group objects;
- * if left empty, will be loaded from group_inbox records
- * @param array $recipient optional list of reply profile ids
- * if left empty, will be loaded from reply records
- * @return array associating recipient user IDs with an inbox source constant
- */
- public function whoGets(array $groups = null, array $recipients = null)
- {
- $c = self::memcache();
- if (!empty($c)) {
- $ni = $c->get(Cache::key('notice:who_gets:'.$this->id));
- if ($ni !== false) {
- return $ni;
- }
- }
- if (is_null($recipients)) {
- $recipients = $this->getReplies();
- }
- $ni = array();
- // Give plugins a chance to add folks in at start...
- if (Event::handle('StartNoticeWhoGets', array($this, &$ni))) {
- $users = $this->getSubscribedUsers();
- foreach ($users as $id) {
- $ni[$id] = NOTICE_INBOX_SOURCE_SUB;
- }
- if (is_null($groups)) {
- $groups = $this->getGroups();
- }
- foreach ($groups as $group) {
- $users = $group->getUserMembers();
- foreach ($users as $id) {
- if (!array_key_exists($id, $ni)) {
- $ni[$id] = NOTICE_INBOX_SOURCE_GROUP;
- }
- }
- }
- $ptAtts = $this->getAttentionsFromProfileTags();
- foreach ($ptAtts as $key=>$val) {
- if (!array_key_exists($key, $ni)) {
- $ni[$key] = $val;
- }
- }
- foreach ($recipients as $recipient) {
- if (!array_key_exists($recipient, $ni)) {
- $ni[$recipient] = NOTICE_INBOX_SOURCE_REPLY;
- }
- }
- // Exclude any deleted, non-local, or blocking recipients.
- $profile = $this->getProfile();
- $originalProfile = null;
- if ($this->isRepeat()) {
- // Check blocks against the original notice's poster as well.
- $original = Notice::getKV('id', $this->repeat_of);
- if ($original instanceof Notice) {
- $originalProfile = $original->getProfile();
- }
- }
- foreach ($ni as $id => $source) {
- try {
- $user = User::getKV('id', $id);
- if (!$user instanceof User ||
- $user->hasBlocked($profile) ||
- ($originalProfile && $user->hasBlocked($originalProfile))) {
- unset($ni[$id]);
- }
- } catch (UserNoProfileException $e) {
- // User doesn't have a profile; invalid; skip them.
- unset($ni[$id]);
- }
- }
- // Give plugins a chance to filter out...
- Event::handle('EndNoticeWhoGets', array($this, &$ni));
- }
- if (!empty($c)) {
- // XXX: pack this data better
- $c->set(Cache::key('notice:who_gets:'.$this->id), $ni);
- }
- return $ni;
- }
- public function getSubscribedUsers()
- {
- $user = new User();
- $user->query(sprintf(
- 'SELECT id FROM %1$s INNER JOIN subscription ' .
- 'ON %1$s.id = subscription.subscriber ' .
- 'WHERE subscription.subscribed = %2$d ',
- $user->escapedTableName(),
- $this->profile_id
- ));
- $ids = [];
- while ($user->fetch()) {
- $ids[] = $user->id;
- }
- $user->free();
- return $ids;
- }
- public function getProfileTags()
- {
- $ptags = array();
- try {
- $profile = $this->getProfile();
- $list = $profile->getOtherTags($profile);
- while ($list->fetch()) {
- $ptags[] = clone($list);
- }
- } catch (Exception $e) {
- common_log(LOG_ERR, "Error during Notice->getProfileTags() for id=={$this->getID()}: {$e->getMessage()}");
- }
- return $ptags;
- }
- public function getAttentionsFromProfileTags()
- {
- $ni = array();
- $ptags = $this->getProfileTags();
- foreach ($ptags as $ptag) {
- $users = $ptag->getUserSubscribers();
- foreach ($users as $id) {
- $ni[$id] = NOTICE_INBOX_SOURCE_PROFILE_TAG;
- }
- }
- return $ni;
- }
- /**
- * Record this notice to the given group inboxes for delivery.
- * Overrides the regular parsing of !group markup.
- *
- * @param string $group_ids
- * @fixme might prefer URIs as identifiers, as for replies?
- * best with generalizations on user_group to support
- * remote groups better.
- */
- public function saveKnownGroups(array $group_ids)
- {
- $groups = array();
- foreach (array_unique($group_ids) as $id) {
- $group = User_group::getKV('id', $id);
- if ($group instanceof User_group) {
- common_log(LOG_DEBUG, "Local delivery to group id $id, $group->nickname");
- $result = $this->addToGroupInbox($group);
- if (!$result) {
- common_log_db_error($gi, 'INSERT', __FILE__);
- }
- if (common_config('group', 'addtag')) {
- // we automatically add a tag for every group name, too
- common_debug('Adding hashtag matching group nickname: '._ve($group->getNickname()));
- $tag = Notice_tag::pkeyGet(array('tag' => common_canonical_tag($group->getNickname()),
- 'notice_id' => $this->getID()));
- if (is_null($tag)) {
- $this->saveTag($group->getNickname());
- }
- }
- $groups[] = clone($group);
- } else {
- common_log(LOG_ERR, "Local delivery to group id $id skipped, doesn't exist");
- }
- }
- return $groups;
- }
- public function addToGroupInbox(User_group $group)
- {
- $gi = Group_inbox::pkeyGet(array('group_id' => $group->id,
- 'notice_id' => $this->id));
- if (!$gi instanceof Group_inbox) {
- $gi = new Group_inbox();
- $gi->group_id = $group->id;
- $gi->notice_id = $this->id;
- $gi->created = $this->created;
- $result = $gi->insert();
- if (!$result) {
- common_log_db_error($gi, 'INSERT', __FILE__);
- // TRANS: Server exception thrown when an update for a group inbox fails.
- throw new ServerException(_('Problem saving group inbox.'));
- }
- self::blow('user_group:notice_ids:%d', $gi->group_id);
- }
- return true;
- }
- public function saveAttentions(array $uris)
- {
- foreach ($uris as $uri=>$type) {
- try {
- $target = Profile::fromUri($uri);
- } catch (UnknownUriException $e) {
- common_log(LOG_WARNING, "Unable to determine profile for URI '$uri'");
- continue;
- }
- try {
- $this->saveAttention($target);
- } catch (AlreadyFulfilledException $e) {
- common_debug('Attention already exists: ' . var_export($e->getMessage(), true));
- } catch (Exception $e) {
- common_log(LOG_ERR, "Could not save notice id=={$this->getID()} attention for profile id=={$target->getID()}: {$e->getMessage()}");
- }
- }
- }
- /**
- * Saves an attention for a profile (user or group) which means
- * it shows up in their home feed and such.
- */
- public function saveAttention(Profile $target, $reason = null)
- {
- if ($target->isGroup()) {
- // FIXME: Make sure we check (for both local and remote) users are in the groups they send to!
- // legacy notification method, will still be in use for quite a while I think
- $this->addToGroupInbox($target->getGroup());
- } else {
- if ($target->hasBlocked($this->getProfile())) {
- common_log(LOG_INFO, "Not saving reply to profile {$target->id} ($uri) from sender {$sender->id} because of a block.");
- return false;
- }
- }
- if ($target->isLocal()) {
- // legacy notification method, will still be in use for quite a while I think
- $this->saveReply($target->getID());
- }
- $att = Attention::saveNew($this, $target, $reason);
- return true;
- }
- /**
- * Save reply records indicating that this notice needs to be
- * delivered to the local users with the given URIs.
- *
- * Since this is expected to be used when saving foreign-sourced
- * messages, we won't deliver to any remote targets as that's the
- * source service's responsibility.
- *
- * Mail notifications etc will be handled later.
- *
- * @param array $uris Array of unique identifier URIs for recipients
- */
- public function saveKnownReplies(array $uris)
- {
- if (empty($uris)) {
- return;
- }
- $sender = $this->getProfile();
- foreach (array_unique($uris) as $uri) {
- try {
- $profile = Profile::fromUri($uri);
- } catch (UnknownUriException $e) {
- common_log(LOG_WARNING, "Unable to determine profile for URI '$uri'");
- continue;
- }
- if ($profile->hasBlocked($sender)) {
- common_log(LOG_INFO, "Not saving reply to profile {$profile->id} ($uri) from sender {$sender->id} because of a block.");
- continue;
- }
- $this->saveReply($profile->getID());
- self::blow('reply:stream:%d', $profile->getID());
- }
- }
- /**
- * Pull @-replies from this message's content in StatusNet markup format
- * and save reply records indicating that this message needs to be
- * delivered to those users.
- *
- * Mail notifications to local profiles will be sent later.
- *
- * @return array of integer profile IDs
- */
- public function saveReplies()
- {
- $sender = $this->getProfile();
- $replied = array();
- // If it's a reply, save for the replied-to author
- try {
- $parent = $this->getParent();
- $parentauthor = $parent->getProfile();
- $this->saveReply($parentauthor->getID());
- $replied[$parentauthor->getID()] = 1;
- self::blow('reply:stream:%d', $parentauthor->getID());
- } catch (NoParentNoticeException $e) {
- // Not a reply, since it has no parent!
- $parent = null;
- } catch (NoResultException $e) {
- // Parent notice was probably deleted
- $parent = null;
- }
- // @todo ideally this parser information would only
- // be calculated once.
- $mentions = common_find_mentions($this->content, $sender, $parent);
- foreach ($mentions as $mention) {
- foreach ($mention['mentioned'] as $mentioned) {
- // skip if they're already covered
- if (array_key_exists($mentioned->id, $replied)) {
- continue;
- }
- // Don't save replies from blocked profile to local user
- if ($mentioned->hasBlocked($sender)) {
- continue;
- }
- $this->saveReply($mentioned->id);
- $replied[$mentioned->id] = 1;
- self::blow('reply:stream:%d', $mentioned->id);
- }
- }
- $recipientIds = array_keys($replied);
- return $recipientIds;
- }
- public function saveReply($profileId)
- {
- $reply = new Reply();
- $reply->notice_id = $this->id;
- $reply->profile_id = $profileId;
- $reply->modified = $this->created;
- $reply->insert();
- return $reply;
- }
- protected $_attentionids = array();
- /**
- * Pull the complete list of known activity context attentions for this notice.
- *
- * @return array of integer profile ids (also group profiles)
- */
- public function getAttentionProfileIDs()
- {
- if (!isset($this->_attentionids[$this->getID()])) {
- $atts = Attention::multiGet('notice_id', array($this->getID()));
- // (array)null means empty array
- $this->_attentionids[$this->getID()] = (array)$atts->fetchAll('profile_id');
- }
- return $this->_attentionids[$this->getID()];
- }
- protected $_replies = array();
- /**
- * Pull the complete list of @-mentioned profile IDs for this notice.
- *
- * @return array of integer profile ids
- */
- public function getReplies()
- {
- if (!isset($this->_replies[$this->getID()])) {
- $mentions = Reply::multiGet('notice_id', array($this->getID()));
- $this->_replies[$this->getID()] = $mentions->fetchAll('profile_id');
- }
- return $this->_replies[$this->getID()];
- }
- public function _setReplies($replies)
- {
- $this->_replies[$this->getID()] = $replies;
- }
- /**
- * Pull the complete list of @-reply targets for this notice.
- *
- * @return array of Profiles
- */
- public function getAttentionProfiles()
- {
- $ids = array_unique(array_merge($this->getReplies(), $this->getGroupProfileIDs(), $this->getAttentionProfileIDs()));
- $profiles = Profile::multiGet('id', (array)$ids);
- return $profiles->fetchAll();
- }
- /**
- * Send e-mail notifications to local @-reply targets.
- *
- * Replies must already have been saved; this is expected to be run
- * from the distrib queue handler.
- */
- public function sendReplyNotifications()
- {
- // Don't send reply notifications for repeats
- if ($this->isRepeat()) {
- return array();
- }
- $recipientIds = $this->getReplies();
- if (Event::handle('StartNotifyMentioned', array($this, &$recipientIds))) {
- require_once INSTALLDIR . '/lib/util/mail.php';
- foreach ($recipientIds as $recipientId) {
- try {
- $user = User::getByID($recipientId);
- mail_notify_attn($user->getProfile(), $this);
- } catch (NoResultException $e) {
- // No such user
- }
- }
- Event::handle('EndNotifyMentioned', array($this, $recipientIds));
- }
- }
- /**
- * Pull list of Profile IDs of groups this notice addresses.
- *
- * @return array of Group _profile_ IDs
- */
- public function getGroupProfileIDs()
- {
- $ids = array();
- foreach ($this->getGroups() as $group) {
- $ids[] = $group->profile_id;
- }
- return $ids;
- }
- /**
- * Pull list of groups this notice needs to be delivered to,
- * as previously recorded by saveKnownGroups().
- *
- * @return array of Group objects
- */
- protected $_groups = array();
- public function getGroups()
- {
- // Don't save groups for repeats
- if (!empty($this->repeat_of)) {
- return array();
- }
- if (isset($this->_groups[$this->id])) {
- return $this->_groups[$this->id];
- }
- $gis = Group_inbox::listGet('notice_id', array($this->id));
- $ids = [];
- foreach ($gis[$this->id] as $gi) {
- $ids[] = $gi->group_id;
- }
- $groups = User_group::multiGet('id', $ids);
- $this->_groups[$this->id] = $groups->fetchAll();
- return $this->_groups[$this->id];
- }
- public function _setGroups($groups)
- {
- $this->_groups[$this->id] = $groups;
- }
- /**
- * Convert a notice into an activity for export.
- *
- * @param Profile $scoped The currently logged in/scoped profile
- *
- * @return Activity activity object representing this Notice.
- * @throws ClientException
- * @throws ServerException
- */
- public function asActivity(Profile $scoped = null)
- {
- $act = self::cacheGet(Cache::codeKey('notice:as-activity:'.$this->id));
- if ($act instanceof Activity) {
- return $act;
- }
- $act = new Activity();
- if (Event::handle('StartNoticeAsActivity', array($this, $act, $scoped))) {
- $act->id = $this->uri;
- $act->time = strtotime($this->created);
- try {
- $act->link = $this->getUrl();
- } catch (InvalidUrlException $e) {
- // The notice is probably a share or similar, which don't
- // have a representational URL of their own.
- }
- $act->content = common_xml_safe_str($this->getRendered());
- $profile = $this->getProfile();
- $act->actor = $profile->asActivityObject();
- $act->actor->extra[] = $profile->profileInfo($scoped);
- $act->verb = $this->verb;
- if (!$this->repeat_of) {
- $act->objects[] = $this->asActivityObject();
- }
- // XXX: should this be handled by default processing for object entry?
- // Categories
- $tags = $this->getTags();
- foreach ($tags as $tag) {
- $cat = new AtomCategory();
- $cat->term = $tag;
- $act->categories[] = $cat;
- }
- // Enclosures
- // XXX: use Atom Media and/or File activity objects instead
- $attachments = $this->attachments();
- foreach ($attachments as $attachment) {
- // Include local attachments in Activity
- if (!empty($attachment->filename)) {
- $act->enclosures[] = $attachment->getEnclosure();
- }
- }
- $ctx = new ActivityContext();
- try {
- $reply = $this->getParent();
- $ctx->replyToID = $reply->getUri();
- $ctx->replyToUrl = $reply->getUrl(true); // true for fallback to local URL, less messy
- } catch (NoParentNoticeException $e) {
- // This is not a reply to something
- } catch (NoResultException $e) {
- // Parent notice was probably deleted
- }
- try {
- $ctx->location = Notice_location::locFromStored($this);
- } catch (ServerException $e) {
- $ctx->location = null;
- }
- $conv = null;
- if (!empty($this->conversation)) {
- $conv = Conversation::getKV('id', $this->conversation);
- if ($conv instanceof Conversation) {
- $ctx->conversation = $conv->uri;
- $ctx->conversation_url = $conv->url;
- }
- }
- // This covers the legacy getReplies and getGroups too which get their data
- // from entries stored via Notice::saveNew (which we want to move away from)...
- foreach ($this->getAttentionProfiles() as $target) {
- // User and group profiles which get the attention of this notice
- $ctx->attention[$target->getUri()] = $target->getObjectType();
- }
- switch ($this->scope) {
- case Notice::PUBLIC_SCOPE:
- $ctx->attention[ActivityContext::ATTN_PUBLIC] = ActivityObject::COLLECTION;
- break;
- case Notice::FOLLOWER_SCOPE:
- $surl = common_local_url("subscribers", array('nickname' => $profile->nickname));
- $ctx->attention[$surl] = ActivityObject::COLLECTION;
- break;
- }
- $act->context = $ctx;
- $source = $this->getSource();
- if ($source instanceof Notice_source) {
- $act->generator = ActivityObject::fromNoticeSource($source);
- }
- // Source
- $atom_feed = $profile->getAtomFeed();
- if (!empty($atom_feed)) {
- $act->source = new ActivitySource();
- // XXX: we should store the actual feed ID
- $act->source->id = $atom_feed;
- // XXX: we should store the actual feed title
- $act->source->title = $profile->getBestName();
- $act->source->links['alternate'] = $profile->profileurl;
- $act->source->links['self'] = $atom_feed;
- $act->source->icon = $profile->avatarUrl(AVATAR_PROFILE_SIZE);
- $notice = $profile->getCurrentNotice();
- if ($notice instanceof Notice) {
- $act->source->updated = self::utcDate($notice->created);
- }
- $user = User::getKV('id', $profile->id);
- if ($user instanceof User) {
- $act->source->links['license'] = common_config('license', 'url');
- }
- }
- try {
- $act->selfLink = $this->getSelfLink();
- } catch (InvalidUrlException $e) {
- $act->selfLink = null;
- }
- if ($this->isLocal()) {
- $act->editLink = $act->selfLink;
- }
- Event::handle('EndNoticeAsActivity', array($this, $act, $scoped));
- }
- self::cacheSet(Cache::codeKey('notice:as-activity:'.$this->id), $act);
- return $act;
- }
- // This has gotten way too long. Needs to be sliced up into functional bits
- // or ideally exported to a utility class.
- public function asAtomEntry($namespace = false, $source = false, $author = true, Profile $scoped = null)
- {
- $act = $this->asActivity($scoped);
- $act->extra[] = $this->noticeInfo($scoped);
- return $act->asString($namespace, $author, $source);
- }
- /**
- * Extra notice info for atom entries
- *
- * Clients use some extra notice info in the atom stream.
- * This gives it to them.
- *
- * @param Profile $scoped The currently logged in/scoped profile
- *
- * @return array representation of <statusnet:notice_info> element
- */
- public function noticeInfo(Profile $scoped = null)
- {
- // local notice ID (useful to clients for ordering)
- $noticeInfoAttr = array('local_id' => $this->id);
- // notice source
- $ns = $this->getSource();
- if ($ns instanceof Notice_source) {
- $noticeInfoAttr['source'] = $ns->code;
- if (!empty($ns->url)) {
- $noticeInfoAttr['source_link'] = $ns->url;
- if (!empty($ns->name)) {
- $noticeInfoAttr['source'] = $ns->name;
- }
- }
- }
- // favorite and repeated
- if ($scoped instanceof Profile) {
- $noticeInfoAttr['repeated'] = ($scoped->hasRepeated($this)) ? "true" : "false";
- }
- if (!empty($this->repeat_of)) {
- $noticeInfoAttr['repeat_of'] = $this->repeat_of;
- }
- Event::handle('StatusNetApiNoticeInfo', array($this, &$noticeInfoAttr, $scoped));
- return array('statusnet:notice_info', $noticeInfoAttr, null);
- }
- /**
- * Returns an XML string fragment with a reference to a notice as an
- * Activity Streams noun object with the given element type.
- *
- * Assumes that 'activity' namespace has been previously defined.
- *
- * @param string $element one of 'subject', 'object', 'target'
- * @return string
- */
- public function asActivityNoun($element)
- {
- $noun = $this->asActivityObject();
- return $noun->asString('activity:' . $element);
- }
- public function asActivityObject()
- {
- $object = new ActivityObject();
- if (Event::handle('StartActivityObjectFromNotice', array($this, &$object))) {
- $object->type = $this->object_type ?: ActivityObject::NOTE;
- $object->id = $this->getUri();
- //FIXME: = $object->title ?: sprintf(... because we might get a title from StartActivityObjectFromNotice
- $object->title = sprintf('New %1$s by %2$s', ActivityObject::canonicalType($object->type), $this->getProfile()->getNickname());
- $object->content = $this->getRendered();
- $object->link = $this->getUrl();
- try {
- $object->selfLink = $this->getSelfLink();
- } catch (InvalidUrlException $e) {
- $object->selfLink = null;
- }
- $object->extra[] = array('statusnet:notice_id', null, $this->id);
- Event::handle('EndActivityObjectFromNotice', array($this, &$object));
- }
- if (!$object instanceof ActivityObject) {
- common_log(LOG_ERR, 'Notice asActivityObject created something else for uri=='._ve($this->getUri()).': '._ve($object));
- throw new ServerException('Notice asActivityObject created something else.');
- }
- return $object;
- }
- /**
- * Determine which notice, if any, a new notice is in reply to.
- *
- * For conversation tracking, we try to see where this notice fits
- * in the tree. Beware that this may very well give false positives
- * and add replies to wrong threads (if there have been newer posts
- * by the same user as we're replying to).
- *
- * @param Profile $sender Author profile
- * @param string $content Final notice content
- *
- * @return integer ID of replied-to notice, or null for not a reply.
- */
- public static function getInlineReplyTo(Profile $sender, $content)
- {
- // Is there an initial @ or T?
- if (preg_match('/^T ([A-Z0-9]{1,64}) /', $content, $match)
- || preg_match('/^@([a-z0-9]{1,64})\s+/', $content, $match)) {
- $nickname = common_canonical_nickname($match[1]);
- } else {
- return null;
- }
- // Figure out who that is.
- $recipient = common_relative_profile($sender, $nickname, common_sql_now());
- if ($recipient instanceof Profile) {
- // Get their last notice
- $last = $recipient->getCurrentNotice();
- if ($last instanceof Notice) {
- return $last;
- }
- // Maybe in the future we want to handle something else below
- // so don't return getCurrentNotice() immediately.
- }
- return null;
- }
- public static function maxContent()
- {
- $contentlimit = common_config('notice', 'contentlimit');
- // null => use global limit (distinct from 0!)
- if (is_null($contentlimit)) {
- $contentlimit = common_config('site', 'textlimit');
- }
- return $contentlimit;
- }
- public static function contentTooLong($content)
- {
- $contentlimit = self::maxContent();
- return ($contentlimit > 0 && !empty($content) && (mb_strlen($content) > $contentlimit));
- }
- /**
- * Convenience function for posting a repeat of an existing message.
- *
- * @param Profile $repeater Profile which is doing the repeat
- * @param string $source: posting source key, eg 'web', 'api', etc
- * @return Notice
- *
- * @throws Exception on failure or permission problems
- */
- public function repeat(Profile $repeater, $source)
- {
- $author = $this->getProfile();
- // TRANS: Message used to repeat a notice. RT is the abbreviation of 'retweet'.
- // TRANS: %1$s is the repeated user's name, %2$s is the repeated notice.
- $content = sprintf(
- _('RT @%1$s %2$s'),
- $author->getNickname(),
- $this->content
- );
- $maxlen = self::maxContent();
- if ($maxlen > 0 && mb_strlen($content) > $maxlen) {
- // Web interface and current Twitter API clients will
- // pull the original notice's text, but some older
- // clients and RSS/Atom feeds will see this trimmed text.
- //
- // Unfortunately this is likely to lose tags or URLs
- // at the end of long notices.
- $content = mb_substr($content, 0, $maxlen - 4) . ' ...';
- }
- // Scope is same as this one's
- return self::saveNew(
- $repeater->id,
- $content,
- $source,
- ['repeat_of' => $this->id, 'scope' => $this->scope]
- );
- }
- // These are supposed to be in chron order!
- public function repeatStream($limit = 100)
- {
- $cache = Cache::instance();
- if (empty($cache)) {
- $ids = $this->_repeatStreamDirect($limit);
- } else {
- $idstr = $cache->get(Cache::key('notice:repeats:'.$this->id));
- if ($idstr !== false) {
- if (!empty($idstr)) {
- $ids = explode(',', $idstr);
- } else {
- $ids = [];
- }
- } else {
- $ids = $this->_repeatStreamDirect(100);
- $cache->set(Cache::key('notice:repeats:'.$this->id), implode(',', $ids));
- }
- if ($limit < 100) {
- // We do a max of 100, so slice down to limit
- $ids = array_slice($ids, 0, $limit);
- }
- }
- return NoticeStream::getStreamByIds($ids);
- }
- public function _repeatStreamDirect($limit)
- {
- $notice = new Notice();
- $notice->selectAdd(); // clears it
- $notice->selectAdd('id');
- $notice->repeat_of = $this->id;
- $notice->orderBy('created, id'); // NB: asc!
- if (!is_null($limit)) {
- $notice->limit(0, $limit);
- }
- return $notice->fetchAll('id');
- }
- public static function locationOptions($lat, $lon, $location_id, $location_ns, $profile = null)
- {
- $options = array();
- if (!empty($location_id) && !empty($location_ns)) {
- $options['location_id'] = $location_id;
- $options['location_ns'] = $location_ns;
- $location = Location::fromId($location_id, $location_ns);
- if ($location instanceof Location) {
- $options['lat'] = $location->lat;
- $options['lon'] = $location->lon;
- }
- } elseif (!empty($lat) && !empty($lon)) {
- $options['lat'] = $lat;
- $options['lon'] = $lon;
- $location = Location::fromLatLon($lat, $lon);
- if ($location instanceof Location) {
- $options['location_id'] = $location->location_id;
- $options['location_ns'] = $location->location_ns;
- }
- } elseif (!empty($profile)) {
- if (isset($profile->lat) && isset($profile->lon)) {
- $options['lat'] = $profile->lat;
- $options['lon'] = $profile->lon;
- }
- if (isset($profile->location_id) && isset($profile->location_ns)) {
- $options['location_id'] = $profile->location_id;
- $options['location_ns'] = $profile->location_ns;
- }
- }
- return $options;
- }
- public function clearAttentions()
- {
- $att = new Attention();
- $att->notice_id = $this->getID();
- if ($att->find()) {
- while ($att->fetch()) {
- // Can't do delete() on the object directly since it won't remove all of it
- $other = clone($att);
- $other->delete();
- }
- }
- }
- public function clearReplies()
- {
- $replyNotice = new Notice();
- $replyNotice->reply_to = $this->id;
- //Null any notices that are replies to this notice
- if ($replyNotice->find()) {
- while ($replyNotice->fetch()) {
- $orig = clone($replyNotice);
- $replyNotice->reply_to = $replyNotice->sqlValue('NULL');
- $replyNotice->update($orig);
- }
- }
- // Reply records
- $reply = new Reply();
- $reply->notice_id = $this->id;
- if ($reply->find()) {
- while ($reply->fetch()) {
- self::blow('reply:stream:%d', $reply->profile_id);
- $reply->delete();
- }
- }
- $reply->free();
- }
- public function clearLocation()
- {
- $loc = new Notice_location();
- $loc->notice_id = $this->id;
- if ($loc->find()) {
- $loc->delete();
- }
- }
- private function clearPrefs(): void
- {
- $prefs = new Notice_prefs();
- $prefs->notice_id = $this->id;
- if ($prefs->find()) {
- $prefs->delete();
- }
- }
- public function clearFiles()
- {
- $f2p = new File_to_post();
- $f2p->post_id = $this->id;
- if ($f2p->find()) {
- while ($f2p->fetch()) {
- $f2p->delete();
- }
- }
- // FIXME: decide whether to delete File objects
- // ...and related (actual) files
- }
- public function clearRepeats()
- {
- $repeatNotice = new Notice();
- $repeatNotice->repeat_of = $this->id;
- //Null any notices that are repeats of this notice
- if ($repeatNotice->find()) {
- while ($repeatNotice->fetch()) {
- $orig = clone($repeatNotice);
- $repeatNotice->repeat_of = $repeatNotice->sqlValue('NULL');
- $repeatNotice->update($orig);
- }
- }
- }
- public function clearTags()
- {
- $tag = new Notice_tag();
- $tag->notice_id = $this->id;
- if ($tag->find()) {
- while ($tag->fetch()) {
- self::blow('profile:notice_ids_tagged:%d:%s', $this->profile_id, Cache::keyize($tag->tag));
- self::blow('profile:notice_ids_tagged:%d:%s;last', $this->profile_id, Cache::keyize($tag->tag));
- self::blow('notice_tag:notice_ids:%s', Cache::keyize($tag->tag));
- self::blow('notice_tag:notice_ids:%s;last', Cache::keyize($tag->tag));
- $tag->delete();
- }
- }
- $tag->free();
- }
- public function clearGroupInboxes()
- {
- $gi = new Group_inbox();
- $gi->notice_id = $this->id;
- if ($gi->find()) {
- while ($gi->fetch()) {
- self::blow('user_group:notice_ids:%d', $gi->group_id);
- $gi->delete();
- }
- }
- $gi->free();
- }
- public function distribute()
- {
- // We always insert for the author so they don't
- // have to wait
- Event::handle('StartNoticeDistribute', array($this));
- // If there's a failure, we want to _force_
- // distribution at this point.
- try {
- $qm = QueueManager::get();
- $qm->enqueue($this, 'distrib');
- } catch (Exception $e) {
- // If the exception isn't transient, this
- // may throw more exceptions as DQH does
- // its own enqueueing. So, we ignore them!
- try {
- $handler = new DistribQueueHandler();
- $handler->handle($this);
- } catch (Exception $e) {
- common_log(LOG_ERR, "emergency redistribution resulted in " . $e->getMessage());
- }
- // Re-throw so somebody smarter can handle it.
- throw $e;
- }
- }
- public function insert()
- {
- $result = parent::insert();
- if ($result === false) {
- common_log_db_error($this, 'INSERT', __FILE__);
- // TRANS: Server exception thrown when a stored object entry cannot be saved.
- throw new ServerException('Could not save Notice');
- }
- // Profile::hasRepeated() abuses pkeyGet(), so we
- // have to clear manually
- if (!empty($this->repeat_of)) {
- $c = self::memcache();
- if (!empty($c)) {
- $ck = self::multicacheKey(
- 'Notice',
- ['profile_id' => $this->profile_id, 'repeat_of' => $this->repeat_of]
- );
- $c->delete($ck);
- }
- }
- // Update possibly ID-dependent columns: URI, conversation
- // (now that INSERT has added the notice's local id)
- $orig = clone($this);
- $changed = false;
- // We can only get here if it's a local notice, since remote notices
- // should've bailed out earlier due to lacking a URI.
- if (empty($this->uri)) {
- $this->uri = sprintf(
- '%s%s=%d:%s=%s',
- TagURI::mint(),
- 'noticeId',
- $this->id,
- 'objectType',
- $this->getObjectType(true)
- );
- $changed = true;
- }
- if ($changed && $this->update($orig) === false) {
- common_log_db_error($notice, 'UPDATE', __FILE__);
- // TRANS: Server exception thrown when a notice cannot be updated.
- throw new ServerException(_('Problem saving notice.'));
- }
- $this->blowOnInsert();
- return $result;
- }
- /**
- * Get the source of the notice
- *
- * @return Notice_source $ns A notice source object. 'code' is the only attribute
- * guaranteed to be populated.
- */
- public function getSource()
- {
- if (empty($this->source)) {
- return false;
- }
- $ns = new Notice_source();
- switch ($this->source) {
- case 'web':
- case 'xmpp':
- case 'mail':
- case 'omb':
- case 'system':
- case 'api':
- $ns->code = $this->source;
- break;
- default:
- $ns = Notice_source::getKV($this->source);
- if (!$ns) {
- $ns = new Notice_source();
- $ns->code = $this->source;
- $app = Oauth_application::getKV('name', $this->source);
- if ($app) {
- $ns->name = $app->name;
- $ns->url = $app->source_url;
- }
- }
- break;
- }
- return $ns;
- }
- /**
- * Determine whether the notice was locally created
- *
- * @return boolean locality
- */
- public function isLocal()
- {
- $is_local = intval($this->is_local);
- return ($is_local === self::LOCAL_PUBLIC || $is_local === self::LOCAL_NONPUBLIC);
- }
- public function getScope()
- {
- return intval($this->scope);
- }
- public function isRepeat()
- {
- return !empty($this->repeat_of);
- }
- public function isRepeated()
- {
- $n = new Notice();
- $n->repeat_of = $this->getID();
- return $n->find() && $n->N > 0;
- }
- /**
- * Get the list of hash tags saved with this notice.
- *
- * @return array of strings
- */
- public function getTags()
- {
- $tags = array();
- $keypart = sprintf('notice:tags:%d', $this->id);
- $tagstr = self::cacheGet($keypart);
- if ($tagstr !== false) {
- $tags = explode(',', $tagstr);
- } else {
- $tag = new Notice_tag();
- $tag->notice_id = $this->id;
- if ($tag->find()) {
- while ($tag->fetch()) {
- $tags[] = $tag->tag;
- }
- }
- self::cacheSet($keypart, implode(',', $tags));
- }
- return $tags;
- }
- private static function utcDate($dt)
- {
- $dateStr = date('d F Y H:i:s', strtotime($dt));
- $d = new DateTime($dateStr, new DateTimeZone('UTC'));
- return $d->format(DATE_W3C);
- }
- /**
- * Look up the creation timestamp for a given notice ID, even
- * if it's been deleted.
- *
- * @param int $id
- * @return mixed string recorded creation timestamp, or false if can't be found
- */
- public static function getAsTimestamp($id)
- {
- if (empty($id)) {
- throw new EmptyPkeyValueException('Notice', 'id');
- }
- $timestamp = null;
- if (Event::handle('GetNoticeSqlTimestamp', array($id, &$timestamp))) {
- // getByID throws exception if $id isn't found
- $notice = Notice::getByID($id);
- $timestamp = $notice->created;
- }
- if (empty($timestamp)) {
- throw new ServerException('No timestamp found for Notice with id=='._ve($id));
- }
- return $timestamp;
- }
- /**
- * Build an SQL 'where' fragment for timestamp-based sorting from a since_id
- * parameter, matching notices posted after the given one (exclusive).
- *
- * If the referenced notice can't be found, will return false.
- *
- * @param int $id
- * @param string $idField
- * @param string $createdField
- * @return mixed string or false if no match
- */
- public static function whereSinceId($id, $idField='id', $createdField='created')
- {
- try {
- $since = Notice::getAsTimestamp($id);
- } catch (Exception $e) {
- return false;
- }
- return sprintf("($createdField = '%s' and $idField > %d) or ($createdField > '%s')", $since, $id, $since);
- }
- /**
- * Build an SQL 'where' fragment for timestamp-based sorting from a since_id
- * parameter, matching notices posted after the given one (exclusive), and
- * if necessary add it to the data object's query.
- *
- * @param DB_DataObject $obj
- * @param int $id
- * @param string $idField
- * @param string $createdField
- * @return mixed string or false if no match
- */
- public static function addWhereSinceId(DB_DataObject $obj, $id, $idField='id', $createdField='created')
- {
- $since = self::whereSinceId($id, $idField, $createdField);
- if ($since) {
- $obj->whereAdd($since);
- }
- }
- /**
- * Build an SQL 'where' fragment for timestamp-based sorting from a max_id
- * parameter, matching notices posted before the given one (inclusive).
- *
- * If the referenced notice can't be found, will return false.
- *
- * @param int $id
- * @param string $idField
- * @param string $createdField
- * @return mixed string or false if no match
- */
- public static function whereMaxId($id, $idField='id', $createdField='created')
- {
- try {
- $max = Notice::getAsTimestamp($id);
- } catch (Exception $e) {
- return false;
- }
- return sprintf("($createdField < '%s') or ($createdField = '%s' and $idField <= %d)", $max, $max, $id);
- }
- /**
- * Build an SQL 'where' fragment for timestamp-based sorting from a max_id
- * parameter, matching notices posted before the given one (inclusive), and
- * if necessary add it to the data object's query.
- *
- * @param DB_DataObject $obj
- * @param int $id
- * @param string $idField
- * @param string $createdField
- * @return mixed string or false if no match
- */
- public static function addWhereMaxId(DB_DataObject $obj, $id, $idField='id', $createdField='created')
- {
- $max = self::whereMaxId($id, $idField, $createdField);
- if ($max) {
- $obj->whereAdd($max);
- }
- }
- public function isPublic()
- {
- $is_local = intval($this->is_local);
- return !($is_local === Notice::LOCAL_NONPUBLIC || $is_local === Notice::GATEWAY);
- }
- /**
- * Check that the given profile is allowed to read, respond to, or otherwise
- * act on this notice.
- *
- * The $scope member is a bitmask of scopes, representing a logical AND of the
- * scope requirement. So, 0x03 (Notice::ADDRESSEE_SCOPE | Notice::SITE_SCOPE) means
- * "only visible to people who are mentioned in the notice AND are users on this site."
- * Users on the site who are not mentioned in the notice will not be able to see the
- * notice.
- *
- * @param Profile $profile The profile to check; pass null to check for public/unauthenticated users.
- *
- * @return boolean whether the profile is in the notice's scope
- */
- public function inScope($profile)
- {
- if (is_null($profile)) {
- $keypart = sprintf('notice:in-scope-for:%d:null', $this->id);
- } else {
- $keypart = sprintf('notice:in-scope-for:%d:%d', $this->id, $profile->id);
- }
- $result = self::cacheGet($keypart);
- if ($result === false) {
- $bResult = false;
- if (Event::handle('StartNoticeInScope', array($this, $profile, &$bResult))) {
- $bResult = $this->_inScope($profile);
- Event::handle('EndNoticeInScope', array($this, $profile, &$bResult));
- }
- $result = ($bResult) ? 1 : 0;
- self::cacheSet($keypart, $result, 0, 300);
- }
- return ($result == 1) ? true : false;
- }
- protected function _inScope($profile)
- {
- $scope = is_null($this->scope) ? self::defaultScope() : $this->getScope();
- if ($scope === 0 && !$this->getProfile()->isPrivateStream()) { // Not scoping, so it is public.
- return !$this->isHiddenSpam($profile);
- }
- // If there's scope, anon cannot be in scope
- if (empty($profile)) {
- return false;
- }
- // Author is always in scope
- if ($this->profile_id == $profile->id) {
- return true;
- }
- // Only for users on this site
- if (($scope & Notice::SITE_SCOPE) && !$profile->isLocal()) {
- return false;
- }
- // Only for users mentioned in the notice
- if ($scope & Notice::ADDRESSEE_SCOPE) {
- $reply = Reply::pkeyGet(array('notice_id' => $this->id,
- 'profile_id' => $profile->id));
- if (!$reply instanceof Reply) {
- return false;
- }
- }
- // Only for members of the given group
- if ($scope & Notice::GROUP_SCOPE) {
- // XXX: just query for the single membership
- $groups = $this->getGroups();
- $foundOne = false;
- foreach ($groups as $group) {
- if ($profile->isMember($group)) {
- $foundOne = true;
- break;
- }
- }
- if (!$foundOne) {
- return false;
- }
- }
- if ($scope & Notice::FOLLOWER_SCOPE || $this->getProfile()->isPrivateStream()) {
- if (!Subscription::exists($profile, $this->getProfile())) {
- return false;
- }
- }
- return !$this->isHiddenSpam($profile);
- }
- public function isHiddenSpam($profile)
- {
- // Hide posts by silenced users from everyone but moderators.
- if (common_config('notice', 'hidespam')) {
- try {
- $author = $this->getProfile();
- } catch (Exception $e) {
- // If we can't get an author, keep it hidden.
- // XXX: technically not spam, but, whatever.
- return true;
- }
- if ($author->hasRole(Profile_role::SILENCED)) {
- if (!$profile instanceof Profile || (($profile->id !== $author->id) && (!$profile->hasRight(Right::REVIEWSPAM)))) {
- return true;
- }
- }
- }
- return false;
- }
- public function hasParent()
- {
- try {
- $this->getParent();
- } catch (NoParentNoticeException $e) {
- return false;
- }
- return true;
- }
- public function getParent()
- {
- $reply_to_id = null;
- if (empty($this->reply_to)) {
- throw new NoParentNoticeException($this);
- }
- // The reply_to ID in the table Notice could exist with a number
- // however, the replied to notice might not exist in the database.
- // Thus we need to catch the exception and throw the NoParentNoticeException else
- // the timeline will not display correctly.
- try {
- $reply_to_id = self::getByID($this->reply_to);
- } catch (Exception $e) {
- throw new NoParentNoticeException($this);
- }
- return $reply_to_id;
- }
- /**
- * Magic function called at serialize() time.
- *
- * We use this to drop a couple process-specific references
- * from DB_DataObject which can cause trouble in future
- * processes.
- *
- * @return array of variable names to include in serialization.
- */
- public function __sleep()
- {
- $vars = parent::__sleep();
- $skip = array('_profile', '_groups', '_attachments', '_faves', '_replies', '_repeats');
- return array_diff($vars, $skip);
- }
- public static function defaultScope()
- {
- $scope = common_config('notice', 'defaultscope');
- if (is_null($scope)) {
- if (common_config('site', 'private')) {
- $scope = 1;
- } else {
- $scope = 0;
- }
- }
- return $scope;
- }
- public static function fillProfiles($notices)
- {
- $map = self::getProfiles($notices);
- foreach ($notices as $entry => $notice) {
- try {
- if (array_key_exists($notice->profile_id, $map)) {
- $notice->_setProfile($map[$notice->profile_id]);
- }
- } catch (NoProfileException $e) {
- common_log(LOG_WARNING, "Failed to fill profile in Notice with non-existing entry for profile_id: {$e->profile_id}");
- unset($notices[$entry]);
- }
- }
- return array_values($map);
- }
- public static function getProfiles(&$notices)
- {
- $ids = [];
- foreach ($notices as $notice) {
- $ids[] = $notice->profile_id;
- }
- $ids = array_unique($ids);
- return Profile::pivotGet('id', $ids);
- }
- public static function fillGroups(&$notices)
- {
- $ids = self::_idsOf($notices);
- $gis = Group_inbox::listGet('notice_id', $ids);
- $gids = [];
- foreach ($gis as $id => $gi) {
- foreach ($gi as $g) {
- $gids[] = $g->group_id;
- }
- }
- $gids = array_unique($gids);
- $group = User_group::pivotGet('id', $gids);
- foreach ($notices as $notice) {
- $grps = [];
- $gi = $gis[$notice->id];
- foreach ($gi as $g) {
- $grps[] = $group[$g->group_id];
- }
- $notice->_setGroups($grps);
- }
- }
- public static function _idsOf(array &$notices)
- {
- $ids = [];
- foreach ($notices as $notice) {
- $ids[$notice->id] = true;
- }
- return array_keys($ids);
- }
- public static function fillAttachments(&$notices)
- {
- $ids = self::_idsOf($notices);
- $f2pMap = File_to_post::listGet('post_id', $ids);
- $fileIds = [];
- foreach ($f2pMap as $noticeId => $f2ps) {
- foreach ($f2ps as $f2p) {
- $fileIds[] = $f2p->file_id;
- }
- }
- $fileIds = array_unique($fileIds);
- $fileMap = File::pivotGet('id', $fileIds);
- foreach ($notices as $notice) {
- $files = [];
- $f2ps = $f2pMap[$notice->id];
- foreach ($f2ps as $f2p) {
- if (!isset($fileMap[$f2p->file_id])) {
- // We have probably deleted value from fileMap since
- // it as a NULL entry (see the following elseif).
- continue;
- } elseif (is_null($fileMap[$f2p->file_id])) {
- // If the file id lookup returned a NULL value, it doesn't
- // exist in our file table! So this is a remnant file_to_post
- // entry that is no longer valid and should be removed.
- common_debug('ATTACHMENT deleting f2p for post_id='.$f2p->post_id.' file_id='.$f2p->file_id);
- $f2p->delete();
- unset($fileMap[$f2p->file_id]);
- continue;
- }
- $files[] = $fileMap[$f2p->file_id];
- }
- $notice->_setAttachments($files);
- }
- }
- public static function fillReplies(&$notices)
- {
- $ids = self::_idsOf($notices);
- $replyMap = Reply::listGet('notice_id', $ids);
- foreach ($notices as $notice) {
- $replies = $replyMap[$notice->id];
- $ids = array();
- foreach ($replies as $reply) {
- $ids[] = $reply->profile_id;
- }
- $notice->_setReplies($ids);
- }
- }
- public static function beforeSchemaUpdate()
- {
- $table = strtolower(get_called_class());
- $schema = Schema::get();
- $schemadef = $schema->getTableDef($table);
- // 2015-09-04 We move Notice location data to Notice_location
- // First we see if we have to do this at all
- if (isset($schemadef['fields']['lat'])
- && isset($schemadef['fields']['lon'])
- && isset($schemadef['fields']['location_id'])
- && isset($schemadef['fields']['location_ns'])) {
- // Then we make sure the Notice_location table is created!
- $schema->ensureTable('notice_location', Notice_location::schemaDef());
- // Then we continue on our road to migration!
- echo "\nFound old $table table, moving location data to 'notice_location' table... (this will probably take a LONG time, but can be aborted and continued)";
- $notice = new Notice();
- $notice->query(sprintf(
- 'SELECT id, lat, lon, location_id, location_ns FROM %1$s ' .
- 'WHERE lat IS NOT NULL ' .
- 'OR lon IS NOT NULL ' .
- 'OR location_id IS NOT NULL ' .
- 'OR location_ns IS NOT NULL',
- common_database_tablename($table)
- ));
- print "\nFound {$notice->N} notices with location data, inserting";
- while ($notice->fetch()) {
- $notloc = Notice_location::getKV('notice_id', $notice->id);
- if ($notloc instanceof Notice_location) {
- print "-";
- continue;
- }
- $notloc = new Notice_location();
- $notloc->notice_id = $notice->id;
- $notloc->lat= $notice->lat;
- $notloc->lon= $notice->lon;
- $notloc->location_id= $notice->location_id;
- $notloc->location_ns= $notice->location_ns;
- $notloc->insert();
- print ".";
- }
- print "\n";
- }
- /**
- * Make sure constraints are met before upgrading, if foreign keys
- * are not already in use.
- * 2016-03-31
- */
- if (!isset($schemadef['foreign keys'])) {
- $newschemadef = self::schemaDef();
- printfnq("\nConstraint checking Notice table...\n");
- /**
- * Improve typing and make sure no NULL values in any id-related columns are 0
- * 2016-03-31
- */
- foreach (['reply_to', 'repeat_of'] as $field) {
- $notice = new Notice(); // reset the object
- $notice->query(sprintf('UPDATE %1$s SET %2$s=NULL WHERE %2$s=0', $notice->escapedTableName(), $field));
- // Now we're sure that no Notice entries have repeat_of=0, only an id > 0 or NULL
- unset($notice);
- }
- /**
- * This Will find foreign keys which do not fulfill the constraints and fix
- * where appropriate, such as delete when "repeat_of" ID not found in notice.id
- * or set to NULL for "reply_to" in the same case.
- * 2016-03-31
- *
- * XXX: How does this work if we would use multicolumn foreign keys?
- */
- foreach (['reply_to' => 'reset', 'repeat_of' => 'delete', 'profile_id' => 'delete'] as $field=>$action) {
- $notice = new Notice();
- $fkeyname = $notice->tableName().'_'.$field.'_fkey';
- assert(isset($newschemadef['foreign keys'][$fkeyname]));
- assert($newschemadef['foreign keys'][$fkeyname]);
- $foreign_key = $newschemadef['foreign keys'][$fkeyname];
- $fkeytable = $foreign_key[0];
- assert(isset($foreign_key[1][$field]));
- $fkeycol = $foreign_key[1][$field];
- printfnq("* {$fkeyname} ({$field} => {$fkeytable}.{$fkeycol})\n");
- // NOTE: Above we set all repeat_of to NULL if they were 0, so this really gets them all.
- $notice->whereAdd(sprintf('%1$s NOT IN (SELECT %2$s FROM %3$s)', $field, $fkeycol, $fkeytable));
- if ($notice->find()) {
- printfnq("\tFound {$notice->N} notices with {$field} NOT IN notice.id, {$action}ing...");
- switch ($action) {
- case 'delete': // since it's a directly dependant notice for an unknown ID we don't want it in our DB
- while ($notice->fetch()) {
- $notice->delete();
- }
- break;
- case 'reset': // just set it to NULL to be compatible with our constraints, if it was related to an unknown ID
- $ids = [];
- foreach ($notice->fetchAll('id') as $id) {
- settype($id, 'int');
- $ids[] = $id;
- }
- unset($notice);
- $notice = new Notice();
- $notice->query(sprintf(
- <<<'END'
- UPDATE %1$s
- SET %2$s = NULL, modified = CURRENT_TIMESTAMP
- WHERE id IN (%3$s)
- END,
- $notice->escapedTableName(),
- $field,
- implode(',', $ids)
- ));
- break;
- default:
- throw new ServerException('The programmer sucks, invalid action name when fixing table.');
- }
- printfnq("DONE.\n");
- }
- unset($notice);
- }
- }
- }
- public function delPref($namespace, $topic)
- {
- return Notice_prefs::setData($this, $namespace, $topic, null);
- }
- public function getPref($namespace, $topic, $default = null)
- {
- // If you want an exception to be thrown, call Notice_prefs::getData directly
- try {
- return Notice_prefs::getData($this, $namespace, $topic, $default);
- } catch (NoResultException $e) {
- return null;
- }
- }
- // The same as getPref but will fall back to common_config value for the same namespace/topic
- public function getConfigPref($namespace, $topic)
- {
- return Notice_prefs::getConfigData($this, $namespace, $topic);
- }
- public function setPref($namespace, $topic, $data)
- {
- return Notice_prefs::setData($this, $namespace, $topic, $data);
- }
- }
|