gnu-social/plugins/Bookmark/classes/Bookmark.php

342 lines
12 KiB
PHP
Raw Normal View History

<?php
/**
* Data class to mark notices as bookmarks
*
* PHP version 5
*
* @category Data
* @package StatusNet
* @author Evan Prodromou <evan@status.net>
* @license http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
* @link http://status.net/
*
* StatusNet - the distributed open-source microblogging tool
* Copyright (C) 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('GNUSOCIAL')) { exit(1); }
/**
* For storing the fact that a notice is a bookmark
*
* @category Bookmark
* @package StatusNet
* @author Evan Prodromou <evan@status.net>
* @license http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
* @link http://status.net/
*
* @see DB_DataObject
*/
class Bookmark extends Managed_DataObject
{
public $__table = 'bookmark'; // table name
public $id; // char(36) primary_key not_null
public $profile_id; // int(4) not_null
public $url; // varchar(191) not_null not 255 because utf8mb4 takes more space
public $title; // varchar(191) not 255 because utf8mb4 takes more space
public $uri; // varchar(191) not 255 because utf8mb4 takes more space
public $description; // text
public $created; // datetime
public static function schemaDef()
{
return array(
'fields' => array(
'id' => array('type' => 'char',
'length' => 36,
'not null' => true),
'profile_id' => array('type' => 'int', 'not null' => true),
'uri' => array('type' => 'varchar',
'length' => 191,
'not null' => true),
'url' => array('type' => 'varchar',
'length' => 191,
'not null' => true),
'title' => array('type' => 'varchar', 'length' => 191),
'description' => array('type' => 'text'),
'created' => array('type' => 'datetime', 'not null' => true),
),
'primary key' => array('uri'),
'unique keys' => array(
'bookmark_id_key' => array('id'),
),
'foreign keys' => array(
'bookmark_profile_id_fkey' => array('profile', array('profile_id' => 'id')),
'bookmark_uri_fkey' => array('notice', array('uri' => 'uri')),
),
'indexes' => array('bookmark_created_idx' => array('created'),
'bookmark_url_idx' => array('url'),
'bookmark_profile_id_idx' => array('profile_id'),
),
);
}
/**
* Get a bookmark based on a notice
*
* @param Notice $stored Notice activity which represents the Bookmark
*
* @return Bookmark The found bookmark object.
* @throws NoResultException When you don't find it after all.
*/
static public function fromStored(Notice $stored)
{
return self::getByPK(array('uri' => $stored->getUri()));
}
2010-12-22 00:32:35 +09:00
/**
* Get the bookmark that a user made for an URL
*
* @param Profile $profile Profile to check for
* @param string $url URL to check for
2010-12-22 00:32:35 +09:00
*
* @return Bookmark bookmark found or null
2010-12-22 00:32:35 +09:00
*/
static function getByURL(Profile $profile, $url)
2010-12-22 00:32:35 +09:00
{
$nb = new Bookmark();
$nb->profile_id = $profile->getID();
$nb->url = $url;
2015-10-11 06:15:51 +09:00
if (!$nb->find(true)) {
throw new NoResultException($nb);
2010-12-22 00:32:35 +09:00
}
2015-10-11 06:15:51 +09:00
return $nb;
2010-12-22 00:32:35 +09:00
}
/**
* Store a Bookmark object
*
* @param Profile $profile To save the bookmark for
* @param string $title Title of the bookmark
* @param string $url URL of the bookmark
* @param string $description Description of the bookmark
*
* @return Bookmark the Bookmark object
*/
static function addNew(Notice $stored, $title, $url, $description)
{
if ($title === '' or is_null($title)) {
throw new ClientException(_m('You must provide a non-empty title.'));
}
if (!common_valid_http_url($url)) {
throw new ClientException(_m('Only web bookmarks can be posted (HTTP or HTTPS).'));
}
try {
$object = self::getByURL($stored->getProfile(), $url);
throw new ClientException(_m('You have already bookmarked this URL.'));
} catch (NoResultException $e) {
// Alright, so then we have to create it.
}
$nb = new Bookmark();
$nb->id = UUID::gen();
$nb->uri = $stored->uri;
$nb->profile_id = $stored->getProfile()->getID();
$nb->title = $title;
$nb->url = $url;
$nb->description = $description;
$nb->created = $stored->created;
$result = $nb->insert();
if ($result === false) {
throw new ServerException('Could not insert Bookmark into database!');
}
/*$hashtags = array();
$taglinks = array();
foreach ($tags as $tag) {
$hashtags[] = '#'.$tag;
$attrs = array('href' => Notice_tag::url($tag),
'rel' => $tag,
'class' => 'tag');
$taglinks[] = XMLStringer::estring('a', $attrs, $tag);
}*/
return $nb;
}
2010-12-22 00:32:35 +09:00
/**
* Save a new notice bookmark
*
* @param Profile $profile To save the bookmark for
* @param string $title Title of the bookmark
* @param string $url URL of the bookmark
2015-10-11 06:15:51 +09:00
* @param array $rawtags array of tags
* @param string $description Description of the bookmark
* @param array $options Options for the Notice::saveNew()
2010-12-22 00:32:35 +09:00
*
* @return Notice saved notice
*/
2015-10-11 06:15:51 +09:00
static function saveNew(Profile $profile, $title, $url, $rawtags, $description,
array $options=array())
2010-12-22 00:32:35 +09:00
{
if (!common_valid_http_url($url)) {
throw new ClientException(_m('Only web bookmarks can be posted (HTTP or HTTPS).'));
}
2015-10-11 06:15:51 +09:00
try {
$object = self::getByURL($profile, $url);
return $object;
} catch (NoResultException $e) {
// Alright, so then we have to create it.
2010-12-22 00:32:35 +09:00
}
2010-12-28 15:57:11 +09:00
if (array_key_exists('uri', $options)) {
$other = Bookmark::getKV('uri', $options['uri']);
2010-12-28 15:57:11 +09:00
if (!empty($other)) {
// TRANS: Client exception thrown when trying to save a new bookmark that already exists.
throw new ClientException(_m('Bookmark already exists.'));
2010-12-28 15:57:11 +09:00
}
}
$nb = new Bookmark();
$nb->id = UUID::gen();
$nb->profile_id = $profile->id;
$nb->url = $url;
$nb->title = $title;
$nb->description = $description;
if (array_key_exists('created', $options)) {
$nb->created = $options['created'];
} else {
$nb->created = common_sql_now();
}
if (array_key_exists('uri', $options)) {
$nb->uri = $options['uri'];
} else {
// FIXME: hacks to work around router bugs in
// queue daemons
$r = Router::get();
$path = $r->build('showbookmark',
array('id' => $nb->id));
if (empty($path)) {
$nb->uri = common_path('bookmark/'.$nb->id, false, false);
} else {
$nb->uri = common_local_url('showbookmark',
array('id' => $nb->id),
null,
null,
false);
}
}
$nb->insert();
2010-12-22 00:32:35 +09:00
$tags = array();
$replies = array();
// filter "for:nickname" tags
foreach ($rawtags as $tag) {
if (strtolower(mb_substr($tag, 0, 4)) == 'for:') {
2010-12-30 07:17:32 +09:00
// skip if done by caller
if (!array_key_exists('replies', $options)) {
$nickname = mb_substr($tag, 4);
$other = common_relative_profile($profile,
$nickname);
if (!empty($other)) {
$replies[] = $other->getUri();
}
2010-12-22 00:32:35 +09:00
}
} else {
$tags[] = common_canonical_tag($tag);
}
}
$hashtags = array();
$taglinks = array();
foreach ($tags as $tag) {
$hashtags[] = '#'.$tag;
$attrs = array('href' => Notice_tag::url($tag),
'rel' => $tag,
'class' => 'tag');
$taglinks[] = XMLStringer::estring('a', $attrs, $tag);
}
// Use user's preferences for short URLs, if possible
try {
$user = User::getKV('id', $profile->id);
$shortUrl = File_redirection::makeShort($url,
empty($user) ? null : $user);
} catch (Exception $e) {
// Don't let this stop us.
$shortUrl = $url;
}
// TRANS: Bookmark content.
// TRANS: %1$s is a title, %2$s is a short URL, %3$s is the bookmark description,
// TRANS: %4$s is space separated list of hash tags.
$content = sprintf(_m('"%1$s" %2$s %3$s %4$s'),
2010-12-22 00:32:35 +09:00
$title,
$shortUrl,
2010-12-22 00:32:35 +09:00
$description,
implode(' ', $hashtags));
// TRANS: Rendered bookmark content.
// TRANS: %1$s is a URL, %2$s the bookmark title, %3$s is the bookmark description,
// TRANS: %4$s is space separated list of hash tags.
$rendered = sprintf(_m('<span class="xfolkentry">'.
'<a class="taggedlink" href="%1$s">%2$s</a> '.
'<span class="description">%3$s</span> '.
'<span class="meta">%4$s</span>'.
2010-12-22 00:32:35 +09:00
'</span>'),
htmlspecialchars($url),
htmlspecialchars($title),
htmlspecialchars($description),
implode(' ', $taglinks));
$options = array_merge(array('urls' => array($url),
'rendered' => $rendered,
'tags' => $tags,
'replies' => $replies,
'object_type' => ActivityObject::BOOKMARK),
$options);
2010-12-22 00:32:35 +09:00
$options['uri'] = $nb->uri;
try {
$saved = Notice::saveNew($profile->id,
$content,
array_key_exists('source', $options) ?
$options['source'] : 'web',
$options);
} catch (Exception $e) {
$nb->delete();
throw $e;
}
if (empty($saved)) {
$nb->delete();
}
2010-12-22 00:32:35 +09:00
return $saved;
}
}