* @link http://status.net/
*/
-if (!defined('STATUSNET')) {
- // This check helps protect against security problems;
- // your code file can't be executed directly from the web.
- exit(1);
-}
+if (!defined('GNUSOCIAL')) { exit(1); }
/**
* widget for displaying a single notice
/** The profile of the author of the notice, extracted once for convenience. */
var $profile = null;
+ protected $addressees = true;
+ protected $attachments = true;
+ protected $id_prefix = null;
+ protected $options = true;
+ protected $maxchars = 0; // if <= 0 it means use full posts
+
/**
* constructor
*
*
* @param Notice $notice The notice we'll display
*/
- function __construct($notice, $out=null)
+ function __construct(Notice $notice, Action $out=null, array $prefs=array())
{
parent::__construct($out);
if (!empty($notice->repeat_of)) {
- $original = Notice::staticGet('id', $notice->repeat_of);
- if (empty($original)) { // could have been deleted
+ $original = Notice::getKV('id', $notice->repeat_of);
+ if (!$original instanceof Notice) { // could have been deleted
$this->notice = $notice;
} else {
$this->notice = $original;
} else {
$this->notice = $notice;
}
+
$this->profile = $this->notice->getProfile();
+
+ // integer preferences
+ foreach(array('maxchars') as $key) {
+ if (array_key_exists($key, $prefs)) {
+ $this->$key = (int)$prefs[$key];
+ }
+ }
+ // boolean preferences
+ foreach(array('addressees', 'attachments', 'options') as $key) {
+ if (array_key_exists($key, $prefs)) {
+ $this->$key = (bool)$prefs[$key];
+ }
+ }
+ // string preferences
+ foreach(array('id_prefix') as $key) {
+ if (array_key_exists($key, $prefs)) {
+ $this->$key = $prefs[$key];
+ }
+ }
}
/**
$this->showStart();
if (Event::handle('StartShowNoticeItem', array($this))) {
$this->showNotice();
- $this->showNoticeAttachments();
- $this->showNoticeInfo();
- $this->showNoticeOptions();
Event::handle('EndShowNoticeItem', array($this));
}
$this->showEnd();
function showNotice()
{
- $this->out->elementStart('div', 'entry-title');
+ if (Event::handle('StartShowNoticeItemNotice', array($this))) {
+ $this->showNoticeHeaders();
+ $this->showContent();
+ $this->showNoticeFooter();
+ Event::handle('EndShowNoticeItemNotice', array($this));
+ }
+ }
+
+ function showNoticeHeaders()
+ {
+ $this->elementStart('section', array('class'=>'notice-headers'));
+ $this->showNoticeTitle();
$this->showAuthor();
- $this->showContent();
- $this->out->elementEnd('div');
+ if ($this->addressees) { $this->showAddressees(); }
+ $this->elementEnd('section');
+ }
+
+ function showNoticeFooter()
+ {
+ $this->elementStart('footer');
+ $this->showNoticeInfo();
+ if ($this->attachments) { $this->showNoticeAttachments(); }
+ if ($this->options) { $this->showNoticeOptions(); }
+ $this->elementEnd('footer');
+ }
+
+ function showNoticeTitle()
+ {
+ if (Event::handle('StartShowNoticeTitle', array($this))) {
+ $this->element('a', array('href' => $this->notice->getUrl(),
+ 'class' => 'notice-title'),
+ $this->notice->getTitle());
+ Event::handle('EndShowNoticeTitle', array($this));
+ }
}
function showNoticeInfo()
{
- $this->out->elementStart('div', 'entry-content');
if (Event::handle('StartShowNoticeInfo', array($this))) {
$this->showNoticeLink();
$this->showNoticeSource();
$this->showNoticeLocation();
- $this->showContext();
+ $this->showPermalink();
$this->showRepeat();
Event::handle('EndShowNoticeInfo', array($this));
}
-
- $this->out->elementEnd('div');
}
function showNoticeOptions()
{
if (Event::handle('StartShowNoticeOptions', array($this))) {
$user = common_current_user();
- if ($user) {
+
+ if ($user instanceof User) {
$this->out->elementStart('div', 'notice-options');
- $this->showFaveForm();
- $this->showReplyLink();
- $this->showRepeatForm();
- $this->showDeleteLink();
+ if (Event::handle('StartShowNoticeOptionItems', array($this))) {
+ $this->showReplyLink();
+ $this->showRepeatForm();
+ $this->showDeleteLink();
+ Event::handle('EndShowNoticeOptionItems', array($this));
+ }
$this->out->elementEnd('div');
}
+
Event::handle('EndShowNoticeOptions', array($this));
}
}
{
if (Event::handle('StartOpenNoticeListItemElement', array($this))) {
$id = (empty($this->repeat)) ? $this->notice->id : $this->repeat->id;
- $class = 'hentry notice';
+ $class = 'h-entry notice';
if ($this->notice->scope != 0 && $this->notice->scope != 1) {
$class .= ' limited-scope';
}
+ if (!empty($this->notice->source)) {
+ $class .= ' notice-source-'.$this->notice->source;
+ }
+ $id_prefix = (strlen($this->id_prefix) ? $this->id_prefix . '-' : '');
$this->out->elementStart('li', array('class' => $class,
- 'id' => 'notice-' . $id));
+ 'id' => "${id_prefix}notice-${id}"));
Event::handle('EndOpenNoticeListItemElement', array($this));
}
}
- /**
- * show the "favorite" form
- *
- * @return void
- */
- function showFaveForm()
- {
- if (Event::handle('StartShowFaveForm', array($this))) {
- $user = common_current_user();
- if ($user) {
- if ($user->hasFave($this->notice)) {
- $disfavor = new DisfavorForm($this->out, $this->notice);
- $disfavor->show();
- } else {
- $favor = new FavorForm($this->out, $this->notice);
- $favor->show();
- }
- }
- Event::handle('EndShowFaveForm', array($this));
- }
- }
-
/**
* show the author of a notice
*
function showAuthor()
{
- $this->out->elementStart('div', 'author');
-
- $this->out->elementStart('span', 'vcard author');
-
$attrs = array('href' => $this->profile->profileurl,
- 'class' => 'url',
- 'title' => $this->profile->nickname);
+ 'class' => 'h-card p-author',
+ 'title' => $this->profile->getNickname());
- $this->out->elementStart('a', $attrs);
- $this->showAvatar();
- $this->out->text(' ');
- $this->out->element('span',array('class' => 'fn'),
- $this->profile->getBestName());
- $this->out->elementEnd('a');
-
- $this->out->elementEnd('span');
-
- $this->showAddressees();
-
- $this->out->elementEnd('div');
+ if (Event::handle('StartShowNoticeItemAuthor', array($this->profile, $this->out, &$attrs))) {
+ $this->out->elementStart('a', $attrs);
+ $this->showAvatar($this->profile);
+ $this->out->text($this->profile->getStreamName());
+ $this->out->elementEnd('a');
+ Event::handle('EndShowNoticeItemAuthor', array($this->profile, $this->out));
+ }
}
function showAddressees()
{
- $ga = $this->getGroupAddressees();
$pa = $this->getProfileAddressees();
- $a = array_merge($ga, $pa);
-
- if (!empty($a)) {
- $this->out->elementStart('span', 'addressees');
+ if (!empty($pa)) {
+ $this->out->elementStart('ul', 'addressees');
$first = true;
- foreach ($a as $addr) {
- if (!$first) {
- // TRANS: Separator in profile addressees list.
- $this->out->text(_m('SEPARATOR',', '));
- } else {
- // Start of profile addressees list.
- $first = false;
- }
+ foreach ($pa as $addr) {
+ $this->out->elementStart('li', 'h-card');
$text = $addr['text'];
unset($addr['text']);
$this->out->element('a', $addr, $text);
+ $this->out->elementEnd('li');
}
- $this->out->elementEnd('span', 'addressees');
- }
- }
-
- function getGroupAddressees()
- {
- $ga = array();
-
- $groups = $this->getGroups();
-
- foreach ($groups as $group) {
- $ga[] = array('href' => $group->homeUrl(),
- 'title' => $group->nickname,
- 'class' => 'addressee group',
- 'text' => $group->getBestName());
+ $this->out->elementEnd('ul', 'addressees');
}
-
- return $ga;
- }
-
- function getGroups()
- {
- return $this->notice->getGroups();
}
function getProfileAddressees()
{
$pa = array();
- $replies = $this->getReplyProfiles();
+ $attentions = $this->getReplyProfiles();
- foreach ($replies as $reply) {
- $pa[] = array('href' => $reply->profileurl,
- 'title' => $reply->nickname,
- 'class' => 'addressee account',
- 'text' => $reply->getBestName());
+ foreach ($attentions as $attn) {
+ $class = $attn->isGroup() ? 'group' : 'account';
+ $pa[] = array('href' => $attn->profileurl,
+ 'title' => $attn->getNickname(),
+ 'class' => "addressee {$class}",
+ 'text' => $attn->getStreamName());
}
return $pa;
return $this->notice->getReplyProfiles();
}
- /**
- * show the avatar of the notice's author
- *
- * This will use the default avatar if no avatar is assigned for the author.
- * It makes a link to the author's profile.
- *
- * @return void
- */
- function showAvatar()
- {
- $avatar_size = $this->avatarSize();
-
- $avatar = $this->profile->getAvatar($avatar_size);
-
- $this->out->element('img', array('src' => ($avatar) ?
- $avatar->displayUrl() :
- Avatar::defaultImage($avatar_size),
- 'class' => 'avatar photo',
- 'width' => $avatar_size,
- 'height' => $avatar_size,
- 'alt' =>
- ($this->profile->fullname) ?
- $this->profile->fullname :
- $this->profile->nickname));
- }
-
- function avatarSize()
- {
- return AVATAR_STREAM_SIZE;
- }
-
/**
* show the nickname of the author
*
*/
function showNickname()
{
- $this->out->raw('<span class="nickname fn">' .
- htmlspecialchars($this->profile->nickname) .
+ $this->out->raw('<span class="p-name">' .
+ htmlspecialchars($this->profile->getNickname()) .
'</span>');
}
function showContent()
{
// FIXME: URL, image, video, audio
- $this->out->elementStart('p', array('class' => 'entry-content'));
- if ($this->notice->rendered) {
- $this->out->raw($this->notice->rendered);
- } else {
- // XXX: may be some uncooked notices in the DB,
- // we cook them right now. This should probably disappear in future
- // versions (>> 0.4.x)
- $this->out->raw(common_render_content($this->notice->content, $this->notice));
+ $this->out->elementStart('article', array('class' => 'e-content'));
+ if (Event::handle('StartShowNoticeContent', array($this->notice, $this->out, $this->out->getScoped()))) {
+ if ($this->maxchars > 0 && mb_strlen($this->notice->content) > $this->maxchars) {
+ $this->out->text(mb_substr($this->notice->content, 0, $this->maxchars) . '[…]');
+ } elseif ($this->notice->rendered) {
+ $this->out->raw($this->notice->rendered);
+ } else {
+ // XXX: may be some uncooked notices in the DB,
+ // we cook them right now. This should probably disappear in future
+ // versions (>> 0.4.x)
+ $this->out->raw(common_render_content($this->notice->content, $this->notice));
+ }
+ Event::handle('EndShowNoticeContent', array($this->notice, $this->out, $this->out->getScoped()));
}
- $this->out->elementEnd('p');
+ $this->out->elementEnd('article');
}
function showNoticeAttachments() {
/**
* show the link to the main page for the notice
*
- * Displays a link to the page for a notice, with "relative" time. Tries to
- * get remote notice URLs correct, but doesn't always succeed.
+ * Displays a local link to the rendered notice, with "relative" time.
*
* @return void
*/
function showNoticeLink()
{
- $noticeurl = $this->notice->bestUrl();
-
- // above should always return an URL
-
- assert(!empty($noticeurl));
-
$this->out->elementStart('a', array('rel' => 'bookmark',
'class' => 'timestamp',
- 'href' => $noticeurl));
- $dt = common_date_iso8601($this->notice->created);
- $this->out->element('abbr', array('class' => 'published',
- 'title' => $dt),
+ 'href' => Conversation::getUrlFromNotice($this->notice)));
+ $this->out->element('time', array('class' => 'dt-published',
+ 'datetime' => common_date_iso8601($this->notice->created),
+ // TRANS: Timestamp title (tooltip text) for NoticeListItem
+ 'title' => common_exact_date($this->notice->created)),
common_date_string($this->notice->created));
$this->out->elementEnd('a');
}
{
$ns = $this->notice->getSource();
- if ($ns) {
- // TRANS: A possible notice source (web interface).
- $source_name = (empty($ns->name)) ? ($ns->code ? _($ns->code) : _m('SOURCE','web')) : _($ns->name);
- $this->out->text(' ');
- $this->out->elementStart('span', 'source');
- // @todo FIXME: probably i18n issue. If "from" is followed by text, that should be a parameter to "from" (from %s).
- // TRANS: Followed by notice source.
- $this->out->text(_('from'));
- $this->out->text(' ');
+ if (!$ns instanceof Notice_source) {
+ return false;
+ }
- $name = $source_name;
- $url = $ns->url;
- $title = null;
+ // TRANS: A possible notice source (web interface).
+ $source_name = (empty($ns->name)) ? ($ns->code ? _($ns->code) : _m('SOURCE','web')) : _($ns->name);
+ $this->out->text(' ');
+ $this->out->elementStart('span', 'source');
+ // @todo FIXME: probably i18n issue. If "from" is followed by text, that should be a parameter to "from" (from %s).
+ // TRANS: Followed by notice source.
+ $this->out->text(_('from'));
+ $this->out->text(' ');
- if (Event::handle('StartNoticeSourceLink', array($this->notice, &$name, &$url, &$title))) {
- $name = $source_name;
- $url = $ns->url;
- }
- Event::handle('EndNoticeSourceLink', array($this->notice, &$name, &$url, &$title));
+ $name = $source_name;
+ $url = $ns->url;
+ $title = null;
- // if $ns->name and $ns->url are populated we have
- // configured a source attr somewhere
- if (!empty($name) && !empty($url)) {
- $this->out->elementStart('span', 'device');
+ if (Event::handle('StartNoticeSourceLink', array($this->notice, &$name, &$url, &$title))) {
+ $name = $source_name;
+ $url = $ns->url;
+ }
+ Event::handle('EndNoticeSourceLink', array($this->notice, &$name, &$url, &$title));
- $attrs = array(
- 'href' => $url,
- 'rel' => 'external'
- );
+ // if $ns->name and $ns->url are populated we have
+ // configured a source attr somewhere
+ if (!empty($name) && !empty($url)) {
+ $this->out->elementStart('span', 'device');
- if (!empty($title)) {
- $attrs['title'] = $title;
- }
+ $attrs = array(
+ 'href' => $url,
+ 'rel' => 'external'
+ );
- $this->out->element('a', $attrs, $name);
- $this->out->elementEnd('span');
- } else {
- $this->out->element('span', 'device', $name);
+ if (!empty($title)) {
+ $attrs['title'] = $title;
}
+ $this->out->element('a', $attrs, $name);
$this->out->elementEnd('span');
+ } else {
+ $this->out->element('span', 'device', $name);
}
+
+ $this->out->elementEnd('span');
}
/**
- * show link to notice this notice is a reply to
+ * show link to single-notice view for this notice item
*
- * If this notice is a reply, show a link to the notice it is replying to. The
- * heavy lifting for figuring out replies happens at save time.
+ * A permalink that goes to this specific object and nothing else
*
* @return void
*/
- function showContext()
+ function showPermalink()
{
- if ($this->notice->hasConversation()) {
- $conv = Conversation::staticGet(
- 'id',
- $this->notice->conversation
- );
- $convurl = $conv->uri;
- if (!empty($convurl)) {
- $this->out->text(' ');
- $this->out->element(
- 'a',
- array(
- 'href' => $convurl.'#notice-'.$this->notice->id,
- 'class' => 'response'),
- // TRANS: Addition in notice list item if notice is part of a conversation.
- _('in context')
- );
- } else {
- $msg = sprintf(
- "Couldn't find Conversation ID %d to make 'in context'"
- . "link for Notice ID %d",
- $this->notice->conversation,
- $this->notice->id
- );
- common_log(LOG_WARNING, $msg);
- }
+ $class = 'permalink u-url';
+ if (!$this->notice->isLocal()) {
+ $class .= ' external';
+ }
+ try {
+ $this->out->element('a',
+ array('href' => $this->notice->getUrl(),
+ 'class' => $class),
+ // TRANS: Addition in notice list item for single-notice view.
+ _('permalink'));
+ } catch (InvalidUrlException $e) {
+ // no permalink available
}
}
{
if (!empty($this->repeat)) {
- $repeater = Profile::staticGet('id', $this->repeat->profile_id);
+ $repeater = Profile::getKV('id', $this->repeat->profile_id);
$attrs = array('href' => $repeater->profileurl,
- 'class' => 'url');
-
- if (!empty($repeater->fullname)) {
- $attrs['title'] = $repeater->fullname . ' (' . $repeater->nickname . ')';
- }
+ 'class' => 'h-card p-author',
+ 'title' => $repeater->getFancyName());
- $this->out->elementStart('span', 'repeat vcard');
+ $this->out->elementStart('span', 'repeat h-entry');
// TRANS: Addition in notice list item if notice was repeated. Followed by a span with a nickname.
- $this->out->raw(_('Repeated by'));
+ $this->out->raw(_('Repeated by').' ');
- $this->out->elementStart('a', $attrs);
- $this->out->element('span', 'fn nickname', $repeater->nickname);
- $this->out->elementEnd('a');
+ $this->out->element('a', $attrs, $repeater->getNickname());
$this->out->elementEnd('span');
}
if (common_logged_in()) {
$this->out->text(' ');
$reply_url = common_local_url('newnotice',
- array('replyto' => $this->profile->nickname, 'inreplyto' => $this->notice->id));
+ array('replyto' => $this->profile->getNickname(), 'inreplyto' => $this->notice->id));
$this->out->elementStart('a', array('href' => $reply_url,
'class' => 'notice_reply',
// TRANS: Link title in notice list item to reply to a notice.
- 'title' => _('Reply to this notice')));
+ 'title' => _('Reply to this notice.')));
// TRANS: Link text in notice list item to reply to a notice.
$this->out->text(_('Reply'));
$this->out->text(' ');
$this->out->element('a', array('href' => $deleteurl,
'class' => 'notice_delete',
// TRANS: Link title in notice list item to delete a notice.
- 'title' => _('Delete this notice')),
+ 'title' => _('Delete this notice from the timeline.')),
// TRANS: Link text in notice list item to delete a notice.
_('Delete'));
}
$user->id != $this->notice->profile_id) {
$this->out->text(' ');
$profile = $user->getProfile();
- if ($profile->hasRepeated($this->notice->id)) {
+ if ($profile->hasRepeated($this->notice)) {
$this->out->element('span', array('class' => 'repeated',
// TRANS: Title for repeat form status in notice list when a notice has been repeated.
'title' => _('Notice repeated.')),
Event::handle('EndCloseNoticeListItemElement', array($this));
}
}
+
+ /**
+ * Get the notice in question
+ *
+ * For hooks, etc., this may be useful
+ *
+ * @return Notice The notice we're showing
+ */
+
+ function getNotice()
+ {
+ return $this->notice;
+ }
}