GNUsocial/gnu-social
4
0
Fork 1
Code Issues Releases Wiki Activity

[TOOLS] Change autocode tag to allow editor folding

Browse Source
This commit is contained in:
Hugo Sales 2020-03-30 14:00:13 +00:00 committed by Hugo Sales
parent f1e72255f1
commit 7e47846b80
Signed by: someonewithpc
GPG Key ID: 7D0C7EAFC9D835A0
57 changed files with 115 additions and 2412 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/Entity/Attention.php
View File

@ -35,9 +35,9 @@ namespace App\Entity;
*/ */
class Attention class Attention
{ {
// AUTOCODE BEGIN // {{{ Autocode
// AUTOCODE END // }}} Autocode
public static function schemaDef(): array public static function schemaDef(): array
{ {

4
src/Entity/Avatar.php
View File

@ -35,9 +35,9 @@ namespace App\Entity;
*/ */
class Avatar class Avatar
{ {
// AUTOCODE BEGIN // {{{ Autocode
// AUTOCODE END // }}} Autocode
public static function schemaDef(): array public static function schemaDef(): array
{ {

4
src/Entity/Config.php
View File

@ -35,9 +35,9 @@ namespace App\Entity;
*/ */
class Config class Config
{ {
// AUTOCODE BEGIN // {{{ Autocode
// AUTOCODE END // }}} Autocode
public static function schemaDef(): array public static function schemaDef(): array
{ {

4
src/Entity/ConfirmAddress.php
View File

@ -35,9 +35,9 @@ namespace App\Entity;
*/ */
class ConfirmAddress class ConfirmAddress
{ {
// AUTOCODE BEGIN // {{{ Autocode
// AUTOCODE END // }}} Autocode
public static function schemaDef(): array public static function schemaDef(): array
{ {

4
src/Entity/Consumer.php
View File

@ -35,9 +35,9 @@ namespace App\Entity;
*/ */
class Consumer class Consumer
{ {
// AUTOCODE BEGIN // {{{ Autocode
// AUTOCODE END // }}} Autocode
public static function schemaDef(): array public static function schemaDef(): array
{ {

4
src/Entity/Conversation.php
View File

@ -33,9 +33,9 @@ namespace App\Entity;
*/ */
class Conversation class Conversation
{ {
// AUTOCODE BEGIN // {{{ Autocode
// AUTOCODE END // }}} Autocode
public static function schemaDef(): array public static function schemaDef(): array
{ {

859
src/Entity/File.php
View File

@ -35,863 +35,9 @@ namespace App\Entity;
*/ */
class File class File
{ {
<<<<<<< HEAD // {{{ Autocode
public $__table = 'file'; // table name
public $id; // int(4) primary_key not_null
public $urlhash; // varchar(64) unique_key
public $url; // text
public $filehash; // varchar(64) indexed
public $mimetype; // varchar(50)
public $size; // int(4)
public $title; // text()
public $date; // int(4)
public $protected; // int(4)
public $filename; // text()
public $width; // int(4)
public $height; // int(4)
public $modified; // timestamp() not_null default_CURRENT_TIMESTAMP
const URLHASH_ALG = 'sha256'; // }}} Autocode
const FILEHASH_ALG = 'sha256';
public static function schemaDef()
{
return array(
'fields' => array(
'id' => array('type' => 'serial', 'not null' => true),
'urlhash' => array('type' => 'varchar', 'length' => 64, 'description' => 'sha256 of destination URL (url field)'),
'url' => array('type' => 'text', 'description' => 'destination URL after following possible redirections'),
'filehash' => array('type' => 'varchar', 'length' => 64, 'not null' => false, 'description' => 'sha256 of the file contents, only for locally stored files of course'),
'mimetype' => array('type' => 'varchar', 'length' => 50, 'description' => 'mime type of resource'),
'size' => array('type' => 'int', 'description' => 'size of resource when available'),
'title' => array('type' => 'text', 'description' => 'title of resource when available'),
'date' => array('type' => 'int', 'description' => 'date of resource according to http query'),
'protected' => array('type' => 'int', 'description' => 'true when URL is private (needs login)'),
'filename' => array('type' => 'text', 'description' => 'if file is stored locally (too) this is the filename'),
'width' => array('type' => 'int', 'description' => 'width in pixels, if it can be described as such and data is available'),
'height' => array('type' => 'int', 'description' => 'height in pixels, if it can be described as such and data is available'),
'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'),
),
'primary key' => array('id'),
'unique keys' => array(
'file_urlhash_key' => array('urlhash'),
),
'indexes' => array(
'file_filehash_idx' => array('filehash'),
),
);
}
public static function isProtected($url)
{
$protected_urls_exps = array(
'https://www.facebook.com/login.php',
common_path('main/login')
);
foreach ($protected_urls_exps as $protected_url_exp) {
if (preg_match('!^'.preg_quote($protected_url_exp).'(.*)$!i', $url) === 1) {
return true;
}
}
return false;
}
/**
* Save a new file record.
*
* @param array $redir_data lookup data eg from File_redirection::where()
* @param string $given_url
* @return File
* @throws ServerException
*/
public static function saveNew(array $redir_data, $given_url)
{
$file = null;
try {
// I don't know why we have to keep doing this but we run a last check to avoid
// uniqueness bugs.
$file = File::getByUrl($given_url);
return $file;
} catch (NoResultException $e) {
// We don't have the file's URL since before, so let's continue.
}
// If the given url is a local attachment url, don't save a new file record.
$uh = parse_url($given_url, PHP_URL_HOST);
$up = parse_url($given_url, PHP_URL_PATH);
if ($uh == common_config('site', 'server') || $uh == common_config('attachments', 'server')) {
unset($uh);
$r = Router::get();
// Skip the / in the beginning or $r->map won't match
try {
$args = $r->map(mb_substr($up, 1));
if ($args['action'] === 'attachment' ||
$args['action'] === 'attachment_view' ||
$args['action'] === 'attachment_download' ||
$args['action'] === 'attachment_thumbnail' ) {
try {
if (array_key_exists('attachment', $args)) {
return File::getByID((int)$args['attachment']);
} elseif (array_key_exists('filehash', $args)) {
$file = File::getByHash($args['filehash']);
$file->fetch();
return $file;
}
} catch (NoResultException $e) {
// apparently this link goes to us, but is _not_ an existing attachment (File) ID?
}
}
} catch (Exception $e) {
// Some other exception was thrown from $r->map, likely a
// ClientException (404) because of some malformed link to
// our own instance. It's still a valid URL however, so we
// won't abort anything... I noticed this when linking:
// https://social.umeahackerspace.se/mmn/foaf' (notice the
// apostrophe in the end, making it unrecognizable for our
// URL routing.
// That specific issue (the apostrophe being part of a link
// is something that may or may not have been fixed since,
// in lib/util.php in common_replace_urls_callback().
}
}
$file = new File;
$file->url = $given_url;
if (!empty($redir_data['protected'])) {
$file->protected = $redir_data['protected'];
}
if (!empty($redir_data['title'])) {
$file->title = $redir_data['title'];
}
if (!empty($redir_data['type'])) {
$file->mimetype = $redir_data['type'];
}
if (!empty($redir_data['size'])) {
$file->size = (int)$redir_data['size'];
}
if (isset($redir_data['time']) && $redir_data['time'] > 0) {
$file->date = (int)$redir_data['time'];
}
$file->saveFile();
return $file;
}
public function saveFile()
{
$this->urlhash = is_null($this->url) ? null : self::hashurl($this->url);
if (!Event::handle('StartFileSaveNew', array(&$this))) {
throw new ServerException('File not saved due to an aborted StartFileSaveNew event.');
}
$this->id = $this->insert();
if ($this->id === false) {
throw new ServerException('File/URL metadata could not be saved to the database.');
}
Event::handle('EndFileSaveNew', array($this));
}
/**
* Go look at a URL and possibly save data about it if it's new:
* - follow redirect chains and store them in file_redirection
* - if a thumbnail is available, save it in file_thumbnail
* - save file record with basic info
* - optionally save a file_to_post record
* - return the File object with the full reference
*
* @param string $given_url the URL we're looking at
* @param Notice|null $notice (optional)
* @param bool $followRedirects defaults to true
*
* @return mixed File on success, -1 on some errors
*
* @throws ServerException on failure
*/
public static function processNew($given_url, ?Notice $notice=null, bool $followRedirects=true)
{
if (empty($given_url)) {
throw new ServerException('No given URL to process');
}
$given_url = File_redirection::_canonUrl($given_url);
if (empty($given_url)) {
throw new ServerException('No canonical URL from given URL to process');
}
$redir = File_redirection::where($given_url);
try {
$file = $redir->getFile();
} catch (EmptyPkeyValueException $e) {
common_log(LOG_ERR, 'File_redirection::where gave object with empty file_id for given_url '._ve($given_url));
throw new ServerException('URL processing failed without new File object');
} catch (NoResultException $e) {
// This should not happen
common_log(LOG_ERR, 'File_redirection after discovery could still not return a File object.');
throw new ServerException('URL processing failed without new File object');
}
if ($notice instanceof Notice) {
File_to_post::processNew($file, $notice);
}
return $file;
}
public static function respectsQuota(Profile $scoped, $fileSize)
{
if ($fileSize > common_config('attachments', 'file_quota')) {
// TRANS: Message used to be inserted as %2$s in the text "No file may
// TRANS: be larger than %1$d byte and the file you sent was %2$s.".
// TRANS: %1$d is the number of bytes of an uploaded file.
$fileSizeText = sprintf(_m('%1$d byte', '%1$d bytes', $fileSize), $fileSize);
$fileQuota = common_config('attachments', 'file_quota');
// TRANS: Message given if an upload is larger than the configured maximum.
// TRANS: %1$d (used for plural) is the byte limit for uploads,
// TRANS: %2$s is the proper form of "n bytes". This is the only ways to have
// TRANS: gettext support multiple plurals in the same message, unfortunately...
throw new ClientException(
sprintf(
_m(
'No file may be larger than %1$d byte and the file you sent was %2$s. Try to upload a smaller version.',
'No file may be larger than %1$d bytes and the file you sent was %2$s. Try to upload a smaller version.',
$fileQuota
),
$fileQuota,
$fileSizeText
)
);
}
$file = new File;
$query = "SELECT sum(size) AS total
FROM file
INNER JOIN file_to_post
ON file_to_post.file_id = file.id
INNER JOIN notice
ON file_to_post.post_id = notice.id
WHERE profile_id = {$scoped->id} AND
filename IS NULL AND
file.url IS NOT NULL";
$file->query($query);
$file->fetch();
$total = $file->total + $fileSize;
if ($total > common_config('attachments', 'user_quota')) {
// TRANS: Message given if an upload would exceed user quota.
// TRANS: %d (number) is the user quota in bytes and is used for plural.
throw new ClientException(
sprintf(
_m(
'A file this large would exceed your user quota of %d byte.',
'A file this large would exceed your user quota of %d bytes.',
common_config('attachments', 'user_quota')
),
common_config('attachments', 'user_quota')
)
);
}
$query .= ' AND EXTRACT(MONTH FROM file.modified) = EXTRACT(MONTH FROM CURRENT_DATE)'
. ' AND EXTRACT(YEAR FROM file.modified) = EXTRACT(YEAR FROM CURRENT_DATE)';
$file->query($query);
$file->fetch();
$total = $file->total + $fileSize;
if ($total > common_config('attachments', 'monthly_quota')) {
// TRANS: Message given id an upload would exceed a user's monthly quota.
// TRANS: $d (number) is the monthly user quota in bytes and is used for plural.
throw new ClientException(
sprintf(
_m(
'A file this large would exceed your monthly quota of %d byte.',
'A file this large would exceed your monthly quota of %d bytes.',
common_config('attachments', 'monthly_quota')
),
common_config('attachments', 'monthly_quota')
)
);
}
return true;
}
public function getFilename()
{
return self::tryFilename($this->filename);
}
public function getSize(): int
{
return (int)$this->size;
}
// where should the file go?
public static function filename(Profile $profile, $origname, $mimetype)
{
$ext = self::guessMimeExtension($mimetype, $origname);
// Normalize and make the original filename more URL friendly.
$origname = basename($origname, ".$ext");
if (class_exists('Normalizer')) {
// http://php.net/manual/en/class.normalizer.php
// http://www.unicode.org/reports/tr15/
$origname = Normalizer::normalize($origname, Normalizer::FORM_KC);
}
$origname = preg_replace('/[^A-Za-z0-9\.\_]/', '_', $origname);
$nickname = $profile->getNickname();
$datestamp = strftime('%Y%m%d', time());
do {
// generate new random strings until we don't run into a filename collision.
$random = strtolower(common_confirmation_code(16));
$filename = "$nickname-$datestamp-$origname-$random.$ext";
} while (file_exists(self::path($filename)));
return $filename;
}
/**
* @param string $filename
* @return null|string|bool Value from the 'extblacklist' array, in the config
* @throws ServerException
*/
public static function getSafeExtension(string $filename)
{
if (preg_match('/^.+?\.([A-Za-z0-9]+)$/', $filename, $matches) === 1) {
// we matched on a file extension, so let's see if it means something.
$ext = mb_strtolower($matches[1]);
$blacklist = common_config('attachments', 'extblacklist');
// If we got an extension from $filename we want to check if it's in a blacklist
// so we avoid people uploading restricted files
if (array_key_exists($ext, $blacklist)) {
if (!is_string($blacklist[$ext])) {
// Blocked
return false;
}
// return a safe replacement extension ('php' => 'phps' for example)
return $blacklist[$ext];
} else {
// the attachment extension based on its filename was not blacklisted so it's ok to use it
return $ext;
}
} else {
// No extension
return null;
}
}
/**
* @param $mimetype string The mimetype we've discovered for this file.
* @param $filename string An optional filename which we can use on failure.
* @return mixed|string
* @throws ClientException
* @throws ServerException
*/
public static function guessMimeExtension($mimetype, $filename=null)
{
try {
// first see if we know the extension for our mimetype
$ext = common_supported_mime_to_ext($mimetype);
// we do, so use it!
return $ext;
} catch (UnknownMimeExtensionException $e) {
// We don't know the extension for this mimetype, but let's guess.
// If we can't recognize the extension from the MIME, we try
// to guess based on filename, if one was supplied.
if (!is_null($filename)) {
$ext = self::getSafeExtension($filename);
if ($ext === false) {
// we don't have a safe replacement extension
throw new ClientException(_m('Blacklisted file extension.'));
} else {
return $ext;
}
}
} catch (Exception $e) {
common_log(LOG_INFO, 'Problem when figuring out extension for mimetype: '._ve($e));
}
// If nothing else has given us a result, try to extract it from
// the mimetype value (this turns .jpg to .jpeg for example...)
$matches = array();
// Will get jpeg from image/jpeg as well as json from application/jrd+json
if (!preg_match('/[\/+-\.]([a-z0-9]+)/', mb_strtolower($mimetype), $matches)) {
throw new Exception("Malformed mimetype: {$mimetype}");
}
return mb_strtolower($matches[1]);
}
/**
* Validation for as-saved base filenames
* @param mixed $filename
* @return false|int
*/
public static function validFilename($filename)
{
return preg_match('/^[A-Za-z0-9._-]+$/', $filename);
}
/**
* @param mixed $filename
* @return string
* @throws InvalidFilenameException
*/
public static function tryFilename($filename): string
{
if (!self::validFilename($filename)) {
throw new InvalidFilenameException($filename);
}
// if successful, return the filename for easy if-statementing
return $filename;
}
/**
* Construct a path
*
* @param mixed $filename Will be tested by tryFilename
* @param string|null $dir Attachments directory by default
* @param bool $test_filename
* @return string
* @throws InvalidFilenameException
* @throws ServerException
*/
public static function path($filename, ?string $dir = null, bool $test_filename = true)
{
if ($test_filename) {
self::tryFilename($filename);
}
$dir = $dir ?? common_config('attachments', 'dir');
if (!in_array($dir[mb_strlen($dir)-1], ['/', '\\'])) {
$dir .= DIRECTORY_SEPARATOR;
}
return $dir . $filename;
}
/**
* Don't use for attachments, only for assets.
*
* @param $filename
* @return mixed|string
* @throws InvalidFilenameException
* @throws ServerException
*/
public static function url($filename)
{
self::tryFilename($filename);
if (common_config('site', 'private')) {
return common_local_url(
'getfile',
array('filename' => $filename)
);
}
if (GNUsocial::useHTTPS()) {
$sslserver = common_config('attachments', 'sslserver');
if (empty($sslserver)) {
// XXX: this assumes that background dir == site dir + /file/
// not true if there's another server
if (is_string(common_config('site', 'sslserver')) &&
mb_strlen(common_config('site', 'sslserver')) > 0) {
$server = common_config('site', 'sslserver');
} elseif (common_config('site', 'server')) {
$server = common_config('site', 'server');
}
$path = common_config('site', 'path') . '/file/';
} else {
$server = $sslserver;
$path = common_config('attachments', 'sslpath');
if (empty($path)) {
$path = common_config('attachments', 'path');
}
}
$protocol = 'https';
} else {
$path = common_config('attachments', 'path');
$server = common_config('attachments', 'server');
if (empty($server)) {
$server = common_config('site', 'server');
}
$ssl = common_config('attachments', 'ssl');
$protocol = ($ssl) ? 'https' : 'http';
}
if ($path[strlen($path)-1] != '/') {
$path .= '/';
}
if ($path[0] != '/') {
$path = '/'.$path;
}
return $protocol.'://'.$server.$path.$filename;
}
public static $_enclosures = array();
public function getEnclosure()
{
if (isset(self::$_enclosures[$this->getID()])) {
return self::$_enclosures[$this->getID()];
}
$enclosure = (object) array();
foreach (array('title', 'url', 'date', 'modified', 'size', 'mimetype', 'width', 'height') as $key) {
if ($this->$key !== '') {
$enclosure->$key = $this->$key;
}
}
$needMoreMetadataMimetypes = array(null, 'application/xhtml+xml', 'text/html');
if (isset($enclosure->url) && in_array(common_bare_mime($enclosure->mimetype), $needMoreMetadataMimetypes)) {
// This fetches enclosure metadata for non-local links with unset/HTML mimetypes,
// which may be enriched through oEmbed or similar (implemented as plugins)
Event::handle('FileEnclosureMetadata', array($this, &$enclosure));
}
if (empty($enclosure->mimetype)) {
// This means we either don't know what it is, so it can't
// be shown as an enclosure, or it is an HTML link which
// does not link to a resource with further metadata.
// throw new ServerException('Unknown enclosure mimetype, not enough metadata');
// It's not really an error that must be shown or handled...
common_debug('Unknown enclosure mimetype, not enough metadata');
}
self::$_enclosures[$this->getID()] = $enclosure;
return $enclosure;
}
public function hasThumbnail()
{
try {
$this->getThumbnail();
} catch (Exception $e) {
return false;
}
return true;
}
/**
* Get the attachment's thumbnail record, if any or generate one.
*
* @param int|null $width Max width of thumbnail in pixels. (if null, use common_config values)
* @param int|null $height Max height of thumbnail in pixels. (if null, square-crop to $width)
* @param bool $crop Crop to the max-values' aspect ratio
* @param bool $force_still Don't allow fallback to showing original (such as animated GIF)
* @param bool|null $upscale Whether or not to scale smaller images up to larger thumbnail sizes. (null = site default)
*
* @return File_thumbnail
*
* @throws ClientException
* @throws FileNotFoundException
* @throws FileNotStoredLocallyException
* @throws InvalidFilenameException
* @throws NoResultException
* @throws ServerException on various other errors
* @throws UnsupportedMediaException if, despite trying, we can't understand how to make a thumbnail for this format
* @throws UseFileAsThumbnailException if the file is considered an image itself and should be itself as thumbnail
*/
public function getThumbnail (?int $width = null, ?int $height = null, bool $crop = false, bool $force_still = true, ?bool $upscale = null): File_thumbnail
{
return File_thumbnail::fromFileObject($this, $width, $height, $crop, $force_still, $upscale);
}
public function getPath()
{
$filepath = self::path($this->filename);
if (!file_exists($filepath)) {
throw new FileNotFoundException($filepath);
}
return $filepath;
}
/**
* Returns the path to either a file, or it's thumbnail if the file doesn't exist.
* This is useful in case the original file is deleted, or, as is the case for Embed
* thumbnails, we only have a thumbnail and not a file
* @param File_thumbnail|null $thumbnail
* @return string Path
* @throws FileNotFoundException
* @throws FileNotStoredLocallyException
* @throws InvalidFilenameException
* @throws ServerException
*/
public function getFileOrThumbnailPath(?File_thumbnail $thumbnail = null): string
{
if (!empty($thumbnail)) {
return $thumbnail->getPath();
}
if (!empty($this->filename)) {
$filepath = self::path($this->filename);
if (file_exists($filepath)) {
return $filepath;
} else {
throw new FileNotFoundException($filepath);
}
} else {
try {
return File_thumbnail::byFile($this, true)->getPath();
} catch (NoResultException $e) {
// File not stored locally
throw new FileNotStoredLocallyException($this);
}
}
}
/**
* Return the mime type of the thumbnail if we have it, or, if not, of the File
* @param File_thumbnail|null $thumbnail
* @return string
* @throws FileNotFoundException
* @throws NoResultException
* @throws ServerException
* @throws UnsupportedMediaException
* @throws Exception
*/
public function getFileOrThumbnailMimetype(?File_thumbnail $thumbnail = null) : string
{
if (!empty($thumbnail)) {
$filepath = $thumbnail->getPath();
} elseif (!empty($this->filename)) {
return $this->mimetype;
} else {
$filepath = File_thumbnail::byFile($this, true)->getPath();
}
$info = @getimagesize($filepath);
if ($info !== false) {
return $info['mime'];
} else {
throw new UnsupportedMediaException(_m("Thumbnail is not an image."));
}
}
/**
* Return the size of the thumbnail if we have it, or, if not, of the File
* @param File_thumbnail|null $thumbnail
* @return int
* @throws FileNotFoundException
* @throws NoResultException
* @throws ServerException
*/
public function getFileOrThumbnailSize(?File_thumbnail $thumbnail = null) : int
{
if (!empty($thumbnail)) {
return filesize($thumbnail->getPath());
} elseif (!empty($this->filename)) {
return $this->getSize();
} else {
return filesize(File_thumbnail::byFile($this)->getPath());
}
}
public function getAttachmentUrl()
{
return common_local_url('attachment', array('attachment'=>$this->getID()));
}
public function getAttachmentDownloadUrl()
{
return common_local_url('attachment_download', ['filehash' => $this->filehash]);
}
public function getAttachmentViewUrl()
{
return common_local_url('attachment_view', ['filehash' => $this->filehash]);
}
/**
* @param bool|null $use_local true means require local, null means prefer original, false means use whatever is stored
* @return string
* @throws FileNotStoredLocallyException
*/
public function getUrl(?bool $use_local=null): ?string
{
if ($use_local !== false) {
if (empty($this->url)) {
// A locally stored file, so let's generate a URL for our instance.
return $this->getAttachmentViewUrl();
}
if ($use_local) {
// if the file isn't ours but and we require a local URL anyway
throw new FileNotStoredLocallyException($this);
}
}
// The original file's URL
return $this->url;
}
public static function getByUrl($url)
{
$file = new File();
$file->urlhash = self::hashurl($url);
if (!$file->find(true)) {
throw new NoResultException($file);
}
return $file;
}
/**
* @param string $hashstr String of (preferrably lower case) hexadecimal characters, same as result of 'hash_file(...)'
* @return File
* @throws NoResultException
*/
public static function getByHash($hashstr)
{
$file = new File();
$file->filehash = strtolower($hashstr);
if (!$file->find()) {
throw new NoResultException($file);
}
return $file;
}
public function updateUrl($url)
{
$file = File::getKV('urlhash', self::hashurl($url));
if ($file instanceof File) {
throw new ServerException('URL already exists in DB');
}
$result = $this->query(sprintf(
<<<'END'
UPDATE %1$s
SET urlhash = %2$s, url = %3$s, modified = CURRENT_TIMESTAMP
WHERE urlhash = %4$s;
END,
$this->tableName(),
$this->_quote((string)self::hashurl($url)),
$this->_quote((string)$url),
$this->_quote((string)$this->urlhash)
));
if ($result === false) {
common_log_db_error($this, 'UPDATE', __FILE__);
throw new ServerException("Could not UPDATE {$this->tableName()}.url");
}
return $result;
}
/**
* Blow the cache of notices that link to this URL
*
* @param boolean $last Whether to blow the "last" cache too
*
* @return void
*/
public function blowCache($last=false)
{
self::blow('file:notice-ids:%s', $this->id);
if ($last) {
self::blow('file:notice-ids:%s;last', $this->id);
}
self::blow('file:notice-count:%d', $this->id);
}
/**
* Stream of notices linking to this URL
*
* @param integer $offset Offset to show; default is 0
* @param integer $limit Limit of notices to show
* @param integer $since_id Since this notice
* @param integer $max_id Before this notice
*
* @return array ids of notices that link to this file
*/
public function stream($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $max_id=0)
{
// FIXME: Try to get the Profile::current() here in some other way to avoid mixing
// the current session user with possibly background/queue processing.
$stream = new FileNoticeStream($this, Profile::current());
return $stream->getNotices($offset, $limit, $since_id, $max_id);
}
public function noticeCount()
{
$cacheKey = sprintf('file:notice-count:%d', $this->id);
$count = self::cacheGet($cacheKey);
if ($count === false) {
$f2p = new File_to_post();
$f2p->file_id = $this->id;
$count = $f2p->count();
self::cacheSet($cacheKey, $count);
}
return $count;
}
// A file with no url and with filename is a local file.
public function isLocal(): bool
{
return empty($this->url) && !empty($this->filename);
}
// A file with an url but no filename is a remote file that wasn't fetched, not even the thumbnail.
public function isNonFetchedRemoteFile(): bool
{
return !empty($this->url) && empty($this->filename);
}
// A file with an url and filename is a fetched remote file (maybe just a thumbnail of it).
public function isFetchedRemoteFile(): bool
{
return !empty($this->url) && !empty($this->filename);
}
// A file with no filename nor url is a redirect.
public function isRedirect(): bool
{
return empty($this->url) && empty($this->filename);
}
// Is in a remote location.
public function isStoredRemotely(): bool
{
return empty($this->filename);
}
public function unlink() {
// Delete the file, if it exists locally
if (!empty($this->filename) && file_exists(self::path($this->filename))) {
$deleted = @unlink(self::path($this->filename));
if (!$deleted) {
common_log(LOG_ERR, sprintf('Could not unlink existing file: "%s"', self::path($this->filename)));
}
}
}
public function delete($useWhere=false)
{
// Delete the file, if it exists locally
$this->unlink();
// Clear out related things in the database and filesystem, such as thumbnails
$related = [
'File_redirection',
'File_thumbnail',
'File_to_post'
=======
// AUTOCODE BEGIN
// AUTOCODE END
public static function schemaDef(): array public static function schemaDef(): array
{ {
@ -919,7 +65,6 @@ class File
'indexes' => [ 'indexes' => [
'file_filehash_idx' => ['filehash'], 'file_filehash_idx' => ['filehash'],
], ],
>>>>>>> ecc5139ce5 ([DATABASE] Extracted schemaDef method from old files and refactored onto new files)
]; ];
} }
} }

4
src/Entity/FileRedirection.php
View File

@ -35,9 +35,9 @@ namespace App\Entity;
*/ */
class FileRedirection class FileRedirection
{ {
// AUTOCODE BEGIN // {{{ Autocode
// AUTOCODE END // }}} Autocode
public static function schemaDef(): array public static function schemaDef(): array
{ {

4
src/Entity/FileThumbnail.php
View File

@ -35,9 +35,9 @@ namespace App\Entity;
*/ */
class FileThumbnail class FileThumbnail
{ {
// AUTOCODE BEGIN // {{{ Autocode
// AUTOCODE END // }}} Autocode
public static function schemaDef(): array public static function schemaDef(): array
{ {

4
src/Entity/FileToPost.php
View File

@ -35,9 +35,9 @@ namespace App\Entity;
*/ */
class FileToPost class FileToPost
{ {
// AUTOCODE BEGIN // {{{ Autocode
// AUTOCODE END // }}} Autocode
public static function schemaDef(): array public static function schemaDef(): array
{ {

4
src/Entity/ForeignLink.php
View File

@ -35,9 +35,9 @@ namespace App\Entity;
*/ */
class ForeignLink class ForeignLink
{ {
// AUTOCODE BEGIN // {{{ Autocode
// AUTOCODE END // }}} Autocode
public static function schemaDef(): array public static function schemaDef(): array
{ {

4
src/Entity/ForeignService.php
View File

@ -35,9 +35,9 @@ namespace App\Entity;
*/ */
class ForeignService class ForeignService
{ {
// AUTOCODE BEGIN // {{{ Autocode
// AUTOCODE END // }}} Autocode
public static function schemaDef(): array public static function schemaDef(): array
{ {

4
src/Entity/ForeignSubscription.php
View File

@ -35,9 +35,9 @@ namespace App\Entity;
*/ */
class ForeignSubscription class ForeignSubscription
{ {
// AUTOCODE BEGIN // {{{ Autocode
// AUTOCODE END // }}} Autocode
public static function schemaDef(): array public static function schemaDef(): array
{ {

4
src/Entity/ForeignUser.php
View File

@ -35,9 +35,9 @@ namespace App\Entity;
*/ */
class ForeignUser class ForeignUser
{ {
// AUTOCODE BEGIN // {{{ Autocode
// AUTOCODE END // }}} Autocode
public static function schemaDef(): array public static function schemaDef(): array
{ {

4
src/Entity/GroupAlias.php
View File

@ -35,9 +35,9 @@ namespace App\Entity;
*/ */
class GroupAlias class GroupAlias
{ {
// AUTOCODE BEGIN // {{{ Autocode
// AUTOCODE END // }}} Autocode
public static function schemaDef(): array public static function schemaDef(): array
{ {

4
src/Entity/GroupBlock.php
View File

@ -35,9 +35,9 @@ namespace App\Entity;
*/ */
class GroupBlock class GroupBlock
{ {
// AUTOCODE BEGIN // {{{ Autocode
// AUTOCODE END // }}} Autocode
public static function schemaDef(): array public static function schemaDef(): array
{ {

4
src/Entity/GroupInbox.php
View File

@ -35,9 +35,9 @@ namespace App\Entity;
*/ */
class GroupInbox class GroupInbox
{ {
// AUTOCODE BEGIN // {{{ Autocode
// AUTOCODE END // }}} Autocode
public static function schemaDef(): array public static function schemaDef(): array
{ {

4
src/Entity/GroupJoinQueue.php
View File

@ -35,9 +35,9 @@ namespace App\Entity;
*/ */
class GroupJoinQueue class GroupJoinQueue
{ {
// AUTOCODE BEGIN // {{{ Autocode
// AUTOCODE END // }}} Autocode
public static function schemaDef(): array public static function schemaDef(): array
{ {

4
src/Entity/GroupMember.php
View File

@ -35,9 +35,9 @@ namespace App\Entity;
*/ */
class GroupMember class GroupMember
{ {
// AUTOCODE BEGIN // {{{ Autocode
// AUTOCODE END // }}} Autocode
public static function schemaDef(): array public static function schemaDef(): array
{ {

4
src/Entity/Invitation.php
View File

@ -35,9 +35,9 @@ namespace App\Entity;
*/ */
class Invitation class Invitation
{ {
// AUTOCODE BEGIN // {{{ Autocode
// AUTOCODE END // }}} Autocode
public static function schemaDef(): array public static function schemaDef(): array
{ {

4
src/Entity/LocalGroup.php
View File

@ -35,9 +35,9 @@ namespace App\Entity;
*/ */
class LocalGroup class LocalGroup
{ {
// AUTOCODE BEGIN // {{{ Autocode
// AUTOCODE END // }}} Autocode
public static function schemaDef(): array public static function schemaDef(): array
{ {

4
src/Entity/LocationNamespace.php
View File

@ -35,9 +35,9 @@ namespace App\Entity;
*/ */
class LocationNamespace class LocationNamespace
{ {
// AUTOCODE BEGIN // {{{ Autocode
// AUTOCODE END // }}} Autocode
public static function schemaDef(): array public static function schemaDef(): array
{ {

4
src/Entity/LoginToken.php
View File

@ -35,9 +35,9 @@ namespace App\Entity;
*/ */
class LoginToken class LoginToken
{ {
// AUTOCODE BEGIN // {{{ Autocode
// AUTOCODE END // }}} Autocode
public static function schemaDef(): array public static function schemaDef(): array
{ {

4
src/Entity/Nonce.php
View File

@ -35,9 +35,9 @@ namespace App\Entity;
*/ */
class Nonce class Nonce
{ {
// AUTOCODE BEGIN // {{{ Autocode
// AUTOCODE END // }}} Autocode
public static function schemaDef(): array public static function schemaDef(): array
{ {

4
src/Entity/Notice.php
View File

@ -35,9 +35,9 @@ namespace App\Entity;
*/ */
class Notice class Notice
{ {
// AUTOCODE BEGIN // {{{ Autocode
// AUTOCODE END // }}} Autocode
public static function schemaDef(): array public static function schemaDef(): array
{ {

4
src/Entity/NoticeLocation.php
View File

@ -35,9 +35,9 @@ namespace App\Entity;
*/ */
class NoticeLocation class NoticeLocation
{ {
// AUTOCODE BEGIN // {{{ Autocode
// AUTOCODE END // }}} Autocode
public static function schemaDef(): array public static function schemaDef(): array
{ {

4
src/Entity/NoticePrefs.php
View File

@ -37,9 +37,9 @@ namespace App\Entity;
*/ */
class NoticePrefs class NoticePrefs
{ {
// AUTOCODE BEGIN // {{{ Autocode
// AUTOCODE END // }}} Autocode
public static function schemaDef(): array public static function schemaDef(): array
{ {

4
src/Entity/NoticeSource.php
View File

@ -35,9 +35,9 @@ namespace App\Entity;
*/ */
class NoticeSource class NoticeSource
{ {
// AUTOCODE BEGIN // {{{ Autocode
// AUTOCODE END // }}} Autocode
public static function schemaDef(): array public static function schemaDef(): array
{ {

4
src/Entity/NoticeTag.php
View File

@ -35,9 +35,9 @@ namespace App\Entity;
*/ */
class NoticeTag class NoticeTag
{ {
// AUTOCODE BEGIN // {{{ Autocode
// AUTOCODE END // }}} Autocode
public static function schemaDef(): array public static function schemaDef(): array
{ {

4
src/Entity/OauthApplication.php
View File

@ -35,9 +35,9 @@ namespace App\Entity;
*/ */
class OauthApplication class OauthApplication
{ {
// AUTOCODE BEGIN // {{{ Autocode
// AUTOCODE END // }}} Autocode
public static function schemaDef(): array public static function schemaDef(): array
{ {

4
src/Entity/OauthApplicationUser.php
View File

@ -35,9 +35,9 @@ namespace App\Entity;
*/ */
class OauthApplicationUser class OauthApplicationUser
{ {
// AUTOCODE BEGIN // {{{ Autocode
// AUTOCODE END // }}} Autocode
public static function schemaDef(): array public static function schemaDef(): array
{ {

4
src/Entity/OauthTokenAssociation.php
View File

@ -35,9 +35,9 @@ namespace App\Entity;
*/ */
class OauthTokenAssociation class OauthTokenAssociation
{ {
// AUTOCODE BEGIN // {{{ Autocode
// AUTOCODE END // }}} Autocode
public static function schemaDef(): array public static function schemaDef(): array
{ {

4
src/Entity/OldSchoolPrefs.php
View File

@ -35,9 +35,9 @@ namespace App\Entity;
*/ */
class OldSchoolPrefs class OldSchoolPrefs
{ {
// AUTOCODE BEGIN // {{{ Autocode
// AUTOCODE END // }}} Autocode
public static function schemaDef(): array public static function schemaDef(): array
{ {

4
src/Entity/Profile.php
View File

@ -35,9 +35,9 @@ namespace App\Entity;
*/ */
class Profile class Profile
{ {
// AUTOCODE BEGIN // {{{ Autocode
// AUTOCODE END // }}} Autocode
public static function schemaDef(): array public static function schemaDef(): array
{ {

4
src/Entity/ProfileBlock.php
View File

@ -35,9 +35,9 @@ namespace App\Entity;
*/ */
class ProfileBlock class ProfileBlock
{ {
// AUTOCODE BEGIN // {{{ Autocode
// AUTOCODE END // }}} Autocode
public static function schemaDef(): array public static function schemaDef(): array
{ {

4
src/Entity/ProfileList.php
View File

@ -35,9 +35,9 @@ namespace App\Entity;
*/ */
class ProfileList class ProfileList
{ {
// AUTOCODE BEGIN // {{{ Autocode
// AUTOCODE END // }}} Autocode
public static function schemaDef(): array public static function schemaDef(): array
{ {

4
src/Entity/ProfilePrefs.php
View File

@ -35,9 +35,9 @@ namespace App\Entity;
*/ */
class ProfilePrefs class ProfilePrefs
{ {
// AUTOCODE BEGIN // {{{ Autocode
// AUTOCODE END // }}} Autocode
public static function schemaDef(): array public static function schemaDef(): array
{ {

4
src/Entity/ProfileRole.php
View File

@ -35,9 +35,9 @@ namespace App\Entity;
*/ */
class ProfileRole class ProfileRole
{ {
// AUTOCODE BEGIN // {{{ Autocode
// AUTOCODE END // }}} Autocode
public static function schemaDef(): array public static function schemaDef(): array
{ {

4
src/Entity/ProfileTag.php
View File

@ -35,9 +35,9 @@ namespace App\Entity;
*/ */
class ProfileTag class ProfileTag
{ {
// AUTOCODE BEGIN // {{{ Autocode
// AUTOCODE END // }}} Autocode
public static function schemaDef(): array public static function schemaDef(): array
{ {

4
src/Entity/ProfileTagSubscription.php
View File

@ -35,9 +35,9 @@ namespace App\Entity;
*/ */
class ProfileTagSubscription class ProfileTagSubscription
{ {
// AUTOCODE BEGIN // {{{ Autocode
// AUTOCODE END // }}} Autocode
public static function schemaDef(): array public static function schemaDef(): array
{ {

4
src/Entity/QueueItem.php
View File

@ -35,9 +35,9 @@ namespace App\Entity;
*/ */
class QueueItem class QueueItem
{ {
// AUTOCODE BEGIN // {{{ Autocode
// AUTOCODE END // }}} Autocode
public static function schemaDef(): array public static function schemaDef(): array
{ {

4
src/Entity/RelatedGroup.php
View File

@ -35,9 +35,9 @@ namespace App\Entity;
*/ */
class RelatedGroup class RelatedGroup
{ {
// AUTOCODE BEGIN // {{{ Autocode
// AUTOCODE END // }}} Autocode
public static function schemaDef(): array public static function schemaDef(): array
{ {

4
src/Entity/RememberMe.php
View File

@ -35,9 +35,9 @@ namespace App\Entity;
*/ */
class RememberMe class RememberMe
{ {
// AUTOCODE BEGIN // {{{ Autocode
// AUTOCODE END // }}} Autocode
public static function schemaDef(): array public static function schemaDef(): array
{ {

4
src/Entity/Reply.php
View File

@ -35,9 +35,9 @@ namespace App\Entity;
*/ */
class Reply class Reply
{ {
// AUTOCODE BEGIN // {{{ Autocode
// AUTOCODE END // }}} Autocode
public static function schemaDef(): array public static function schemaDef(): array
{ {

4
src/Entity/SchemaVersion.php
View File

@ -35,9 +35,9 @@ namespace App\Entity;
*/ */
class SchemaVersion class SchemaVersion
{ {
// AUTOCODE BEGIN // {{{ Autocode
// AUTOCODE END // }}} Autocode
public static function schemaDef(): array public static function schemaDef(): array
{ {

4
src/Entity/Session.php
View File

@ -37,9 +37,9 @@ namespace App\Entity;
*/ */
class Session class Session
{ {
// AUTOCODE BEGIN // {{{ Autocode
// AUTOCODE END // }}} Autocode
public static function schemaDef(): array public static function schemaDef(): array
{ {

4
src/Entity/SmsCarrier.php
View File

@ -35,9 +35,9 @@ namespace App\Entity;
*/ */
class SmsCarrier class SmsCarrier
{ {
// AUTOCODE BEGIN // {{{ Autocode
// AUTOCODE END // }}} Autocode
public static function schemaDef(): array public static function schemaDef(): array
{ {

428
src/Entity/Subscription.php
View File

@ -35,431 +35,10 @@ namespace App\Entity;
*/ */
class Subscription class Subscription
{ {
<<<<<<< HEAD // {{{ Autocode
const CACHE_WINDOW = 201; >>>>>>> e63aa4d971 ([TOOLS] Change autocode tag to allow editor folding)
const FORCE = true;
public $__table = 'subscription'; // table name // }}} Autocode
public $subscriber; // int(4) primary_key not_null
public $subscribed; // int(4) primary_key not_null
public $jabber; // bool default_true
public $sms; // bool default_true
public $token; // varchar(191) not 255 because utf8mb4 takes more space
public $secret; // varchar(191) not 255 because utf8mb4 takes more space
public $uri; // varchar(191) not 255 because utf8mb4 takes more space
public $created; // datetime()
public $modified; // timestamp() not_null default_CURRENT_TIMESTAMP
public static function schemaDef()
{
return array(
'fields' => array(
'subscriber' => array('type' => 'int', 'not null' => true, 'description' => 'profile listening'),
'subscribed' => array('type' => 'int', 'not null' => true, 'description' => 'profile being listened to'),
'jabber' => array('type' => 'bool', 'default' => true, 'description' => 'deliver jabber messages'),
'sms' => array('type' => 'bool', 'default' => true, 'description' => 'deliver sms messages'),
'token' => array('type' => 'varchar', 'length' => 191, 'description' => 'authorization token'),
'secret' => array('type' => 'varchar', 'length' => 191, 'description' => 'token secret'),
'uri' => array('type' => 'varchar', 'length' => 191, 'description' => 'universally unique identifier'),
'created' => array('type' => 'datetime', 'description' => 'date this record was created'),
'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'),
),
'primary key' => array('subscriber', 'subscribed'),
'unique keys' => array(
'subscription_uri_key' => array('uri'),
),
'indexes' => array(
'subscription_subscriber_created_subscribed_idx' => array('subscriber', 'created', 'subscribed'),
'subscription_subscribed_created_subscriber_idx' => array('subscribed', 'created', 'subscriber'),
'subscription_token_idx' => array('token'),
),
);
}
/**
* Make a new subscription
*
* @param Profile $subscriber party to receive new notices
* @param Profile $other party sending notices; publisher
* @param bool $force pass Subscription::FORCE to override local subscription approval
*
* @return mixed Subscription or Subscription_queue: new subscription info
*/
public static function start(Profile $subscriber, Profile $other, $force = false)
{
if (!$subscriber->hasRight(Right::SUBSCRIBE)) {
// TRANS: Exception thrown when trying to subscribe while being banned from subscribing.
throw new Exception(_('You have been banned from subscribing.'));
}
if (self::exists($subscriber, $other)) {
// TRANS: Exception thrown when trying to subscribe while already subscribed.
throw new AlreadyFulfilledException(_('Already subscribed!'));
}
if ($other->hasBlocked($subscriber)) {
// TRANS: Exception thrown when trying to subscribe to a user who has blocked the subscribing user.
throw new Exception(_('User has blocked you.'));
}
if (Event::handle('StartSubscribe', array($subscriber, $other))) {
// unless subscription is forced, the user policy for subscription approvals is tested
if (!$force && $other->requiresSubscriptionApproval($subscriber)) {
try {
$sub = Subscription_queue::saveNew($subscriber, $other);
$sub->notify();
} catch (AlreadyFulfilledException $e) {
$sub = Subscription_queue::getSubQueue($subscriber, $other);
}
} else {
$otherUser = User::getKV('id', $other->id);
$sub = self::saveNew($subscriber, $other);
$sub->notify();
self::blow('user:notices_with_friends:%d', $subscriber->id);
self::blow('subscription:by-subscriber:'.$subscriber->id);
self::blow('subscription:by-subscribed:'.$other->id);
$subscriber->blowSubscriptionCount();
$other->blowSubscriberCount();
if ($otherUser instanceof User &&
$otherUser->autosubscribe &&
!self::exists($other, $subscriber) &&
!$subscriber->hasBlocked($other)) {
try {
self::start($other, $subscriber);
} catch (AlreadyFulfilledException $e) {
// This shouldn't happen due to !self::exists above
common_debug('Tried to autosubscribe a user to its new subscriber.');
} catch (Exception $e) {
common_log(LOG_ERR, "Exception during autosubscribe of {$other->nickname} to profile {$subscriber->id}: {$e->getMessage()}");
}
}
}
if ($sub instanceof Subscription) { // i.e. not Subscription_queue
Event::handle('EndSubscribe', array($subscriber, $other));
}
}
return $sub;
}
public static function ensureStart(Profile $subscriber, Profile $other, $force = false)
{
try {
$sub = self::start($subscriber, $other, $force);
} catch (AlreadyFulfilledException $e) {
return self::getSubscription($subscriber, $other);
}
return $sub;
}
/**
* Low-level subscription save.
* Outside callers should use Subscription::start()
*/
protected static function saveNew(Profile $subscriber, Profile $other)
{
$sub = new Subscription();
$sub->subscriber = $subscriber->getID();
$sub->subscribed = $other->getID();
$sub->jabber = true;
$sub->sms = true;
$sub->created = common_sql_now();
$sub->uri = self::newUri(
$subscriber,
$other,
$sub->created
);
$result = $sub->insert();
if ($result===false) {
common_log_db_error($sub, 'INSERT', __FILE__);
// TRANS: Exception thrown when a subscription could not be stored on the server.
throw new Exception(_('Could not save subscription.'));
}
return $sub;
}
public function notify()
{
// XXX: add other notifications (Jabber, SMS) here
// XXX: queue this and handle it offline
// XXX: Whatever happens, do it in Twitter-like API, too
$this->notifyEmail();
}
public function notifyEmail()
{
$subscribedUser = User::getKV('id', $this->subscribed);
if ($subscribedUser instanceof User) {
$subscriber = Profile::getKV('id', $this->subscriber);
mail_subscribe_notify_profile($subscribedUser, $subscriber);
}
}
/**
* Cancel a subscription
*
*/
public static function cancel(Profile $subscriber, Profile $other)
{
if (!self::exists($subscriber, $other)) {
// TRANS: Exception thrown when trying to unsibscribe without a subscription.
throw new AlreadyFulfilledException(_('Not subscribed!'));
}
// Don't allow deleting self subs
if ($subscriber->id == $other->id) {
// TRANS: Exception thrown when trying to unsubscribe a user from themselves.
throw new Exception(_('Could not delete self-subscription.'));
}
if (Event::handle('StartUnsubscribe', array($subscriber, $other))) {
$sub = Subscription::pkeyGet(array('subscriber' => $subscriber->id,
'subscribed' => $other->id));
// note we checked for existence above
assert(!empty($sub));
$result = $sub->delete();
if (!$result) {
common_log_db_error($sub, 'DELETE', __FILE__);
// TRANS: Exception thrown when a subscription could not be deleted on the server.
throw new Exception(_('Could not delete subscription.'));
}
self::blow('user:notices_with_friends:%d', $subscriber->id);
self::blow('subscription:by-subscriber:'.$subscriber->id);
self::blow('subscription:by-subscribed:'.$other->id);
$subscriber->blowSubscriptionCount();
$other->blowSubscriberCount();
Event::handle('EndUnsubscribe', array($subscriber, $other));
}
return;
}
public static function exists(Profile $subscriber, Profile $other)
{
try {
$sub = self::getSubscription($subscriber, $other);
} catch (NoResultException $e) {
return false;
}
return true;
}
public static function getSubscription(Profile $subscriber, Profile $other)
{
// This is essentially a pkeyGet but we have an object to return in NoResultException
$sub = new Subscription();
$sub->subscriber = $subscriber->id;
$sub->subscribed = $other->id;
if (!$sub->find(true)) {
throw new NoResultException($sub);
}
return $sub;
}
public function getSubscriber()
{
return Profile::getByID($this->subscriber);
}
public function getSubscribed()
{
return Profile::getByID($this->subscribed);
}
public function asActivity()
{
$subscriber = $this->getSubscriber();
$subscribed = $this->getSubscribed();
$act = new Activity();
$act->verb = ActivityVerb::FOLLOW;
// XXX: rationalize this with the URL
$act->id = $this->getUri();
$act->time = strtotime($this->created);
// TRANS: Activity title when subscribing to another person.
$act->title = _m('TITLE', 'Follow');
// TRANS: Notification given when one person starts following another.
// TRANS: %1$s is the subscriber, %2$s is the subscribed.
$act->content = sprintf(
_('%1$s is now following %2$s.'),
$subscriber->getBestName(),
$subscribed->getBestName()
);
$act->actor = $subscriber->asActivityObject();
$act->objects[] = $subscribed->asActivityObject();
$url = common_local_url(
'AtomPubShowSubscription',
[
'subscriber' => $subscriber->id,
'subscribed' => $subscribed->id,
]
);
$act->selfLink = $url;
$act->editLink = $url;
return $act;
}
/**
* Stream of subscriptions with the same subscriber
*
* Useful for showing pages that list subscriptions in reverse
* chronological order. Has offset & limit to make paging
* easy.
*
* @param integer $profile_id ID of the subscriber profile
* @param integer $offset Offset from latest
* @param integer $limit Maximum number to fetch
*
* @return Subscription stream of subscriptions; use fetch() to iterate
*/
public static function bySubscriber($profile_id, $offset = 0, $limit = PROFILES_PER_PAGE)
{
// "by subscriber" means it is the list of subscribed users we want
$ids = self::getSubscribedIDs($profile_id, $offset, $limit);
return Subscription::listFind('subscribed', $ids);
}
/**
* Stream of subscriptions with the same subscriber
*
* Useful for showing pages that list subscriptions in reverse
* chronological order. Has offset & limit to make paging
* easy.
*
* @param integer $profile_id ID of the subscribed profile
* @param integer $offset Offset from latest
* @param integer $limit Maximum number to fetch
*
* @return Subscription stream of subscriptions; use fetch() to iterate
*/
public static function bySubscribed($profile_id, $offset = 0, $limit = PROFILES_PER_PAGE)
{
// "by subscribed" means it is the list of subscribers we want
$ids = self::getSubscriberIDs($profile_id, $offset, $limit);
return Subscription::listFind('subscriber', $ids);
}
// The following are helper functions to the subscription lists,
// notably the public ones get used in places such as Profile
public static function getSubscribedIDs($profile_id, $offset, $limit)
{
return self::getSubscriptionIDs('subscribed', $profile_id, $offset, $limit);
}
public static function getSubscriberIDs($profile_id, $offset, $limit)
{
return self::getSubscriptionIDs('subscriber', $profile_id, $offset, $limit);
}
private static function getSubscriptionIDs($get_type, $profile_id, $offset, $limit)
{
switch ($get_type) {
case 'subscribed':
$by_type = 'subscriber';
break;
case 'subscriber':
$by_type = 'subscribed';
break;
default:
throw new Exception('Bad type argument to getSubscriptionIDs');
}
$cacheKey = 'subscription:by-'.$by_type.':'.$profile_id;
$queryoffset = $offset;
$querylimit = $limit;
if ($offset + $limit <= self::CACHE_WINDOW) {
// Oh, it seems it should be cached
$ids = self::cacheGet($cacheKey);
if (is_array($ids)) {
return array_slice($ids, $offset, $limit);
}
// Being here indicates we didn't find anything cached
// so we'll have to fill it up simultaneously
$queryoffset = 0;
$querylimit = self::CACHE_WINDOW;
}
$sub = new Subscription();
$sub->$by_type = $profile_id;
$sub->selectAdd($get_type);
$sub->whereAdd($get_type . ' <> ' . $profile_id);
$sub->orderBy("created DESC, {$get_type} DESC");
$sub->limit($queryoffset, $querylimit);
if (!$sub->find()) {
return array();
}
$ids = $sub->fetchAll($get_type);
// If we're simultaneously filling up cache, remember to slice
if ($queryoffset === 0 && $querylimit === self::CACHE_WINDOW) {
self::cacheSet($cacheKey, $ids);
return array_slice($ids, $offset, $limit);
}
return $ids;
}
/**
* Flush cached subscriptions when subscription is updated
*
* Because we cache subscriptions, it's useful to flush them
* here.
*
* @param mixed $dataObject Original version of object
*
* @return boolean success flag.
*/
public function update($dataObject = false)
{
self::blow('subscription:by-subscriber:'.$this->subscriber);
self::blow('subscription:by-subscribed:'.$this->subscribed);
return parent::update($dataObject);
}
public function getUri()
{
return $this->uri ?: self::newUri($this->getSubscriber(), $this->getSubscribed(), $this->created);
=======
// AUTOCODE BEGIN
// AUTOCODE END
public static function schemaDef(): array public static function schemaDef(): array
{ {
@ -486,6 +65,5 @@ class Subscription
'subscription_token_idx' => ['token'], 'subscription_token_idx' => ['token'],
], ],
]; ];
>>>>>>> e4b74a6aaf ([DATABASE] Extracted schemaDef method from old files and refactored onto new files)
} }
} }

4
src/Entity/SubscriptionQueue.php
View File

@ -35,9 +35,9 @@ namespace App\Entity;
*/ */
class SubscriptionQueue class SubscriptionQueue
{ {
// AUTOCODE BEGIN // {{{ Autocode
// AUTOCODE END // }}} Autocode
public static function schemaDef(): array public static function schemaDef(): array
{ {

4
src/Entity/Token.php
View File

@ -35,9 +35,9 @@ namespace App\Entity;
*/ */
class Token class Token
{ {
// AUTOCODE BEGIN // {{{ Autocode
// AUTOCODE END // }}} Autocode
public static function schemaDef(): array public static function schemaDef(): array
{ {

4
src/Entity/UnavailableStatusNetwork.php
View File

@ -35,9 +35,9 @@ namespace App\Entity;
*/ */
class UnavailableStatusNetwork class UnavailableStatusNetwork
{ {
// AUTOCODE BEGIN // {{{ Autocode
// AUTOCODE END // }}} Autocode
public static function schemaDef(): array public static function schemaDef(): array
{ {

1024
src/Entity/User.php
View File

File diff suppressed because it is too large Load Diff

4
src/Entity/UserGroup.php
View File

@ -35,9 +35,9 @@ namespace App\Entity;
*/ */
class UserGroup class UserGroup
{ {
// AUTOCODE BEGIN // {{{ Autocode
// AUTOCODE END // }}} Autocode
public static function schemaDef(): array public static function schemaDef(): array
{ {

4
src/Entity/UserImPrefs.php
View File

@ -33,9 +33,9 @@ namespace App\Entity;
*/ */
class UserImPrefs class UserImPrefs
{ {
// AUTOCODE BEGIN // {{{ Autocode
// AUTOCODE END // }}} Autocode
public static function schemaDef(): array public static function schemaDef(): array
{ {

4
src/Entity/UserLocationPrefs.php
View File

@ -33,9 +33,9 @@ namespace App\Entity;
*/ */
class UserLocationPrefs class UserLocationPrefs
{ {
// AUTOCODE BEGIN // {{{ Autocode
// AUTOCODE END // }}} Autocode
public static function schemaDef(): array public static function schemaDef(): array
{ {

4
src/Entity/UserUrlshortenerPrefs.php
View File

@ -35,9 +35,9 @@ namespace App\Entity;
*/ */
class UserUrlshortenerPrefs class UserUrlshortenerPrefs
{ {
// AUTOCODE BEGIN // {{{ Autocode
// AUTOCODE END // }}} Autocode
public static function schemaDef(): array public static function schemaDef(): array
{ {

4
src/Entity/UserUsername.php
View File

@ -35,9 +35,9 @@ namespace App\Entity;
*/ */
class UserUsername class UserUsername
{ {
// AUTOCODE BEGIN // {{{ Autocode
// AUTOCODE END // }}} Autocode
public static function schemaDef(): array public static function schemaDef(): array
{ {