forked from GNUsocial/gnu-social
0b35ce7c37
We've been muddling through with 6- or 8-argument functions for managing streams. I'd like to start thinking of streams as their own thing, and give them some more value. So, the new NoticeStream class takes over the Notice::stream() function and Notice::getStreamByIds(). There's probably some fine-tuning to do on the object interface.
519 lines
19 KiB
PHP
519 lines
19 KiB
PHP
<?php
|
|
/*
|
|
* StatusNet - the distributed open-source microblogging tool
|
|
* Copyright (C) 2008, 2009, StatusNet, Inc.
|
|
*
|
|
* This program 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.
|
|
*
|
|
* This program 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 this program. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); }
|
|
|
|
require_once INSTALLDIR.'/classes/Memcached_DataObject.php';
|
|
require_once INSTALLDIR.'/classes/File_redirection.php';
|
|
require_once INSTALLDIR.'/classes/File_oembed.php';
|
|
require_once INSTALLDIR.'/classes/File_thumbnail.php';
|
|
require_once INSTALLDIR.'/classes/File_to_post.php';
|
|
//require_once INSTALLDIR.'/classes/File_redirection.php';
|
|
|
|
/**
|
|
* Table Definition for file
|
|
*/
|
|
class File extends Memcached_DataObject
|
|
{
|
|
###START_AUTOCODE
|
|
/* the code below is auto generated do not remove the above tag */
|
|
|
|
public $__table = 'file'; // table name
|
|
public $id; // int(4) primary_key not_null
|
|
public $url; // varchar(255) unique_key
|
|
public $mimetype; // varchar(50)
|
|
public $size; // int(4)
|
|
public $title; // varchar(255)
|
|
public $date; // int(4)
|
|
public $protected; // int(4)
|
|
public $filename; // varchar(255)
|
|
public $modified; // timestamp() not_null default_CURRENT_TIMESTAMP
|
|
|
|
/* Static get */
|
|
function staticGet($k,$v=NULL) { return Memcached_DataObject::staticGet('File',$k,$v); }
|
|
|
|
/* the code above is auto generated do not remove the tag below */
|
|
###END_AUTOCODE
|
|
|
|
function isProtected($url) {
|
|
return 'http://www.facebook.com/login.php' === $url;
|
|
}
|
|
|
|
/**
|
|
* Get the attachments for a particlar notice.
|
|
*
|
|
* @param int $post_id
|
|
* @return array of File objects
|
|
*/
|
|
static function getAttachments($post_id) {
|
|
$file = new File();
|
|
$query = "select file.* from file join file_to_post on (file_id = file.id) where post_id = " . $file->escape($post_id);
|
|
$file = Memcached_DataObject::cachedQuery('File', $query);
|
|
$att = array();
|
|
while ($file->fetch()) {
|
|
$att[] = clone($file);
|
|
}
|
|
return $att;
|
|
}
|
|
|
|
/**
|
|
* Save a new file record.
|
|
*
|
|
* @param array $redir_data lookup data eg from File_redirection::where()
|
|
* @param string $given_url
|
|
* @return File
|
|
*/
|
|
function saveNew(array $redir_data, $given_url) {
|
|
$x = new File;
|
|
$x->url = $given_url;
|
|
if (!empty($redir_data['protected'])) $x->protected = $redir_data['protected'];
|
|
if (!empty($redir_data['title'])) $x->title = $redir_data['title'];
|
|
if (!empty($redir_data['type'])) $x->mimetype = $redir_data['type'];
|
|
if (!empty($redir_data['size'])) $x->size = intval($redir_data['size']);
|
|
if (isset($redir_data['time']) && $redir_data['time'] > 0) $x->date = intval($redir_data['time']);
|
|
$file_id = $x->insert();
|
|
|
|
$x->saveOembed($redir_data, $given_url);
|
|
return $x;
|
|
}
|
|
|
|
/**
|
|
* Save embedding information for this file, if applicable.
|
|
*
|
|
* Normally this won't need to be called manually, as File::saveNew()
|
|
* takes care of it.
|
|
*
|
|
* @param array $redir_data lookup data eg from File_redirection::where()
|
|
* @param string $given_url
|
|
* @return boolean success
|
|
*/
|
|
public function saveOembed($redir_data, $given_url)
|
|
{
|
|
if (isset($redir_data['type'])
|
|
&& (('text/html' === substr($redir_data['type'], 0, 9) || 'application/xhtml+xml' === substr($redir_data['type'], 0, 21)))
|
|
&& ($oembed_data = File_oembed::_getOembed($given_url))) {
|
|
|
|
$fo = File_oembed::staticGet('file_id', $this->id);
|
|
|
|
if (empty($fo)) {
|
|
File_oembed::saveNew($oembed_data, $this->id);
|
|
return true;
|
|
} else {
|
|
common_log(LOG_WARNING, "Strangely, a File_oembed object exists for new file $file_id", __FILE__);
|
|
}
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Go look at a URL and possibly save data about it if it's new:
|
|
* - follow redirect chains and store them in file_redirection
|
|
* - look up oEmbed data and save it in file_oembed
|
|
* - 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
|
|
*
|
|
* @fixme refactor this mess, it's gotten pretty scary.
|
|
* @param string $given_url the URL we're looking at
|
|
* @param int $notice_id (optional)
|
|
* @param bool $followRedirects defaults to true
|
|
*
|
|
* @return mixed File on success, -1 on some errors
|
|
*
|
|
* @throws ServerException on some errors
|
|
*/
|
|
public function processNew($given_url, $notice_id=null, $followRedirects=true) {
|
|
if (empty($given_url)) return -1; // error, no url to process
|
|
$given_url = File_redirection::_canonUrl($given_url);
|
|
if (empty($given_url)) return -1; // error, no url to process
|
|
$file = File::staticGet('url', $given_url);
|
|
if (empty($file)) {
|
|
$file_redir = File_redirection::staticGet('url', $given_url);
|
|
if (empty($file_redir)) {
|
|
// @fixme for new URLs this also looks up non-redirect data
|
|
// such as target content type, size, etc, which we need
|
|
// for File::saveNew(); so we call it even if not following
|
|
// new redirects.
|
|
$redir_data = File_redirection::where($given_url);
|
|
if (is_array($redir_data)) {
|
|
$redir_url = $redir_data['url'];
|
|
} elseif (is_string($redir_data)) {
|
|
$redir_url = $redir_data;
|
|
$redir_data = array();
|
|
} else {
|
|
// TRANS: Server exception thrown when a URL cannot be processed.
|
|
throw new ServerException(sprintf(_("Cannot process URL '%s'"), $given_url));
|
|
}
|
|
// TODO: max field length
|
|
if ($redir_url === $given_url || strlen($redir_url) > 255 || !$followRedirects) {
|
|
$x = File::saveNew($redir_data, $given_url);
|
|
$file_id = $x->id;
|
|
} else {
|
|
// This seems kind of messed up... for now skipping this part
|
|
// if we're already under a redirect, so we don't go into
|
|
// horrible infinite loops if we've been given an unstable
|
|
// redirect (where the final destination of the first request
|
|
// doesn't match what we get when we ask for it again).
|
|
//
|
|
// Seen in the wild with clojure.org, which redirects through
|
|
// wikispaces for auth and appends session data in the URL params.
|
|
$x = File::processNew($redir_url, $notice_id, /*followRedirects*/false);
|
|
$file_id = $x->id;
|
|
File_redirection::saveNew($redir_data, $file_id, $given_url);
|
|
}
|
|
} else {
|
|
$file_id = $file_redir->file_id;
|
|
}
|
|
} else {
|
|
$file_id = $file->id;
|
|
$x = $file;
|
|
}
|
|
|
|
if (empty($x)) {
|
|
$x = File::staticGet($file_id);
|
|
if (empty($x)) {
|
|
// @todo FIXME: This could possibly be a clearer message :)
|
|
// TRANS: Server exception thrown when... Robin thinks something is impossible!
|
|
throw new ServerException(_('Robin thinks something is impossible.'));
|
|
}
|
|
}
|
|
|
|
if (!empty($notice_id)) {
|
|
File_to_post::processNew($file_id, $notice_id);
|
|
}
|
|
return $x;
|
|
}
|
|
|
|
function isRespectsQuota($user,$fileSize) {
|
|
|
|
if ($fileSize > common_config('attachments', 'file_quota')) {
|
|
// TRANS: Message given if an upload is larger than the configured maximum.
|
|
// TRANS: %1$d is the byte limit for uploads, %2$d is the byte count for the uploaded file.
|
|
// TRANS: %1$s is used for plural.
|
|
return sprintf(_m('No file may be larger than %1$d byte and the file you sent was %2$d bytes. Try to upload a smaller version.',
|
|
'No file may be larger than %1$d bytes and the file you sent was %2$d bytes. Try to upload a smaller version.',
|
|
common_config('attachments', 'file_quota')),
|
|
common_config('attachments', 'file_quota'), $fileSize);
|
|
}
|
|
|
|
$query = "select sum(size) as total from file join file_to_post on file_to_post.file_id = file.id join notice on file_to_post.post_id = notice.id where profile_id = {$user->id} and file.url like '%/notice/%/file'";
|
|
$this->query($query);
|
|
$this->fetch();
|
|
$total = $this->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.
|
|
return 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 now()) and EXTRACT(year FROM file.modified) = EXTRACT(year FROM now())';
|
|
$this->query($query);
|
|
$this->fetch();
|
|
$total = $this->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.
|
|
return 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;
|
|
}
|
|
|
|
// where should the file go?
|
|
|
|
static function filename($profile, $basename, $mimetype)
|
|
{
|
|
require_once 'MIME/Type/Extension.php';
|
|
|
|
// We have to temporarily disable auto handling of PEAR errors...
|
|
PEAR::staticPushErrorHandling(PEAR_ERROR_RETURN);
|
|
|
|
$mte = new MIME_Type_Extension();
|
|
$ext = $mte->getExtension($mimetype);
|
|
if (PEAR::isError($ext)) {
|
|
$ext = strtolower(preg_replace('/\W/', '', $mimetype));
|
|
}
|
|
|
|
// Restore error handling.
|
|
PEAR::staticPopErrorHandling();
|
|
|
|
$nickname = $profile->nickname;
|
|
$datestamp = strftime('%Y%m%dT%H%M%S', time());
|
|
$random = strtolower(common_confirmation_code(32));
|
|
return "$nickname-$datestamp-$random.$ext";
|
|
}
|
|
|
|
/**
|
|
* Validation for as-saved base filenames
|
|
*/
|
|
static function validFilename($filename)
|
|
{
|
|
return preg_match('/^[A-Za-z0-9._-]+$/', $filename);
|
|
}
|
|
|
|
/**
|
|
* @throws ClientException on invalid filename
|
|
*/
|
|
static function path($filename)
|
|
{
|
|
if (!self::validFilename($filename)) {
|
|
// TRANS: Client exception thrown if a file upload does not have a valid name.
|
|
throw new ClientException(_("Invalid filename."));
|
|
}
|
|
$dir = common_config('attachments', 'dir');
|
|
|
|
if ($dir[strlen($dir)-1] != '/') {
|
|
$dir .= '/';
|
|
}
|
|
|
|
return $dir . $filename;
|
|
}
|
|
|
|
static function url($filename)
|
|
{
|
|
if (!self::validFilename($filename)) {
|
|
// TRANS: Client exception thrown if a file upload does not have a valid name.
|
|
throw new ClientException(_("Invalid filename."));
|
|
}
|
|
|
|
if (common_config('site','private')) {
|
|
|
|
return common_local_url('getfile',
|
|
array('filename' => $filename));
|
|
|
|
}
|
|
|
|
if (StatusNet::isHTTPS()) {
|
|
|
|
$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');
|
|
} else if (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;
|
|
}
|
|
|
|
function getEnclosure(){
|
|
$enclosure = (object) array();
|
|
$enclosure->title=$this->title;
|
|
$enclosure->url=$this->url;
|
|
$enclosure->title=$this->title;
|
|
$enclosure->date=$this->date;
|
|
$enclosure->modified=$this->modified;
|
|
$enclosure->size=$this->size;
|
|
$enclosure->mimetype=$this->mimetype;
|
|
|
|
if(! isset($this->filename)){
|
|
$notEnclosureMimeTypes = array(null,'text/html','application/xhtml+xml');
|
|
$mimetype = $this->mimetype;
|
|
if($mimetype != null){
|
|
$mimetype = strtolower($this->mimetype);
|
|
}
|
|
$semicolon = strpos($mimetype,';');
|
|
if($semicolon){
|
|
$mimetype = substr($mimetype,0,$semicolon);
|
|
}
|
|
if(in_array($mimetype,$notEnclosureMimeTypes)){
|
|
// Never treat generic HTML links as an enclosure type!
|
|
// But if we have oEmbed info, we'll consider it golden.
|
|
$oembed = File_oembed::staticGet('file_id',$this->id);
|
|
if($oembed && in_array($oembed->type, array('photo', 'video'))){
|
|
$mimetype = strtolower($oembed->mimetype);
|
|
$semicolon = strpos($mimetype,';');
|
|
if($semicolon){
|
|
$mimetype = substr($mimetype,0,$semicolon);
|
|
}
|
|
// @fixme uncertain if this is right.
|
|
// we want to expose things like YouTube videos as
|
|
// viewable attachments, but don't expose them as
|
|
// downloadable enclosures.....?
|
|
//if (in_array($mimetype, $notEnclosureMimeTypes)) {
|
|
// return false;
|
|
//} else {
|
|
if($oembed->mimetype) $enclosure->mimetype=$oembed->mimetype;
|
|
if($oembed->url) $enclosure->url=$oembed->url;
|
|
if($oembed->title) $enclosure->title=$oembed->title;
|
|
if($oembed->modified) $enclosure->modified=$oembed->modified;
|
|
unset($oembed->size);
|
|
//}
|
|
} else {
|
|
return false;
|
|
}
|
|
}
|
|
}
|
|
return $enclosure;
|
|
}
|
|
|
|
// quick back-compat hack, since there's still code using this
|
|
function isEnclosure()
|
|
{
|
|
$enclosure = $this->getEnclosure();
|
|
return !empty($enclosure);
|
|
}
|
|
|
|
/**
|
|
* Get the attachment's thumbnail record, if any.
|
|
*
|
|
* @return File_thumbnail
|
|
*/
|
|
function getThumbnail()
|
|
{
|
|
return File_thumbnail::staticGet('file_id', $this->id);
|
|
}
|
|
|
|
/**
|
|
* Blow the cache of notices that link to this URL
|
|
*
|
|
* @param boolean $last Whether to blow the "last" cache too
|
|
*
|
|
* @return void
|
|
*/
|
|
|
|
function blowCache($last=false)
|
|
{
|
|
self::blow('file:notice-ids:%s', $this->url);
|
|
if ($last) {
|
|
self::blow('file:notice-ids:%s;last', $this->url);
|
|
}
|
|
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
|
|
*/
|
|
|
|
function stream($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $max_id=0)
|
|
{
|
|
$stream = new NoticeStream(array($this, '_streamDirect'),
|
|
array(),
|
|
'file:notice-ids:'.$this->url);
|
|
|
|
return $stream->getNotices($offset, $limit, $since_id, $max_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
|
|
*/
|
|
|
|
function _streamDirect($offset, $limit, $since_id, $max_id)
|
|
{
|
|
$f2p = new File_to_post();
|
|
|
|
$f2p->selectAdd();
|
|
$f2p->selectAdd('post_id');
|
|
|
|
$f2p->file_id = $this->id;
|
|
|
|
Notice::addWhereSinceId($f2p, $since_id, 'post_id', 'modified');
|
|
Notice::addWhereMaxId($f2p, $max_id, 'post_id', 'modified');
|
|
|
|
$f2p->orderBy('modified DESC, post_id DESC');
|
|
|
|
if (!is_null($offset)) {
|
|
$f2p->limit($offset, $limit);
|
|
}
|
|
|
|
$ids = array();
|
|
|
|
if ($f2p->find()) {
|
|
while ($f2p->fetch()) {
|
|
$ids[] = $f2p->post_id;
|
|
}
|
|
}
|
|
|
|
return $ids;
|
|
}
|
|
|
|
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;
|
|
}
|
|
}
|