/**
* build a notification related to an article
*
* The action can be one of the following:
* - 'apply' - surfer would like to get access to the page
* - 'publish' - either a published page has been posted, or a draft page has been published
* - 'submit' - a draft page has been posted
* - 'update' - a page (draft or published) has been modified
*
* This function builds a mail message that displays:
* - an image of the contributor (if possible)
* - a headline mentioning the contribution
* - the full content of the new comment
* - a button linked to the reply page
* - a link to the containing page
*
* Note: this function returns legacy HTML, not modern XHTML, because this is what most
* e-mail client software can afford.
*
* @param string either 'apply', 'publish', 'submit' or 'update'
* @param array attributes of the item
* @param object overlay of the item, if any
* @return string text to be send by e-mail
*/
public static function build_notification($action = 'publish', $item, $overlay = NULL)
{
global $context;
// sanity check
if (!isset($item['anchor']) || !($anchor = Anchors::get($item['anchor']))) {
throw new Exception('no anchor for this article');
}
// compute page title
if (is_object($overlay)) {
$title = Codes::beautify_title($overlay->get_text('title', $item));
} else {
$title = Codes::beautify_title($item['title']);
}
// headline link to section
$headline_link = '<a href="' . $context['url_to_home'] . $context['url_to_root'] . $anchor->get_url() . '">' . $anchor->get_title() . '</a>';
// headline template
switch ($action) {
case 'apply':
$template = i18n::c('%s is requesting access to %s');
$headline_link = '<a href="' . Articles::get_permalink($item) . '">' . $title . '</a>';
break;
case 'publish':
$template = i18n::c('%s has posted a page in %s');
break;
case 'submit':
$template = i18n::c('%s has submitted a page in %s');
break;
case 'update':
$template = i18n::c('%s has updated a page in %s');
break;
}
// headline
$headline = sprintf($template, Surfer::get_link(), $headline_link);
// panel content
$content = '';
// more insight on this page
$prefix = $suffix = '';
// signal articles to be published
if (!isset($item['publish_date']) || $item['publish_date'] <= NULL_DATE || $item['publish_date'] > gmstrftime('%Y-%m-%d %H:%M:%S')) {
$prefix .= DRAFT_FLAG;
}
// signal restricted and private articles
if ($item['active'] == 'N') {
$prefix .= PRIVATE_FLAG;
} elseif ($item['active'] == 'R') {
$prefix .= RESTRICTED_FLAG;
}
// flag expired articles
if (isset($item['expiry_date']) && $item['expiry_date'] > NULL_DATE && $item['expiry_date'] <= $context['now']) {
$prefix .= EXPIRED_FLAG . ' ';
}
// signal locked articles
if (isset($item['locked']) && $item['locked'] == 'Y' && Articles::is_owned($item, $anchor)) {
$suffix .= ' ' . LOCKED_FLAG;
}
// insert page title
$content .= '<h3><span>' . $prefix . $title . $suffix . '</span></h3>';
// insert anchor prefix
if (is_object($anchor)) {
$content .= $anchor->get_prefix();
}
// the introduction text, if any
if (is_object($overlay)) {
$content .= Skin::build_block($overlay->get_text('introduction', $item), 'introduction');
} elseif (isset($item['introduction']) && trim($item['introduction'])) {
$content .= Skin::build_block($item['introduction'], 'introduction');
}
// get text related to the overlay, if any
if (is_object($overlay)) {
$content .= $overlay->get_text('diff', $item);
}
// filter description, if necessary
if (is_object($overlay)) {
$description = $overlay->get_text('description', $item);
} else {
$description = $item['description'];
}
// the beautified description, which is the actual page body
if ($description) {
// use adequate label
if (is_object($overlay) && ($label = $overlay->get_label('description'))) {
$content .= Skin::build_block($label, 'title');
}
// beautify the target page
$content .= Skin::build_block($description, 'description', '', $item['options']);
}
// attachment details
$details = array();
// avoid first file in list if mentioned in last comment
$file_offset = 0;
// comments
include_once $context['path_to_root'] . 'comments/comments.php';
if ($count = Comments::count_for_anchor('article:' . $item['id'], TRUE)) {
// get last contribution for this page
if ($comment = Comments::get_newest_for_anchor('article:' . $item['id'])) {
if (preg_match('/\\[(download|file)=/', $comment['description'])) {
$file_offset++;
}
// bars around the last contribution
$bottom_menu = array();
// last contributor
$contributor = Users::get_link($comment['create_name'], $comment['create_address'], $comment['create_id']);
$flag = '';
if ($comment['create_date'] >= $context['fresh']) {
$flag = NEW_FLAG;
} elseif ($comment['edit_date'] >= $context['fresh']) {
$flag = UPDATED_FLAG;
}
$bottom_menu[] = sprintf(i18n::s('By %s'), $contributor) . ' ' . Skin::build_date($comment['create_date']) . $flag;
// gather pieces
$pieces = array();
// last contribution, and user signature
$pieces[] = ucfirst(trim($comment['description'])) . Users::get_signature($comment['create_id']);
// bottom
if ($bottom_menu) {
$pieces[] = '<div>' . ucfirst(trim(Skin::finalize_list($bottom_menu, 'menu'))) . '</div>';
}
// put all pieces together
$content .= '<div>' . "\n" . join("\n", $pieces) . '</div>' . "\n";
}
// count comments
$details[] = sprintf(i18n::nc('%d comment', '%d comments', $count), $count);
}
// info on related files
if ($count = Files::count_for_anchor('article:' . $item['id'])) {
// most recent files attached to this page
if ($items = Files::list_by_date_for_anchor('article:' . $item['id'], $file_offset, 3, 'dates')) {
// more files than listed
$more = '';
if ($count > 3) {
$more = '<span class="details">' . sprintf(i18n::s('%d files, including:'), $count) . '</span>';
}
if (is_array($items)) {
$items = Skin::build_list($items, 'compact');
}
$items = '<div>' . $more . $items . '</div>';
}
// wrap it with some header
if ($items) {
$content .= '<h3><span>' . i18n::c('Files') . '</span></h3>' . $items;
}
// count files
$details[] = sprintf(i18n::nc('%d file', '%d files', $count), $count);
}
// info on related links
include_once $context['path_to_root'] . 'links/links.php';
if ($count = Links::count_for_anchor('article:' . $item['id'], TRUE)) {
$details[] = sprintf(i18n::nc('%d link', '%d links', $count), $count);
}
// describe attachments
if (count($details)) {
$content .= '<hr align="left" size=1" width="150">' . '<p>' . sprintf(i18n::c('This page has %s'), join(', ', $details)) . '</p>';
}
// assemble main content of this message
$text = Skin::build_mail_content($headline, $content);
// a set of links
$menu = array();
// request access to the item
if ($action == 'apply') {
// call for action
$link = $context['url_to_home'] . $context['url_to_root'] . Articles::get_url($item['id'], 'invite', Surfer::get_id());
$label = sprintf(i18n::c('Invite %s to participate'), Surfer::get_name());
$menu[] = Skin::build_mail_button($link, $label, TRUE);
// link to user profile
$link = Surfer::get_permalink();
$label = sprintf(i18n::c('View the profile of %s'), Surfer::get_name());
$menu[] = Skin::build_mail_button($link, $label, FALSE);
// invite to visit the item
} else {
// call for action
$link = Articles::get_permalink($item);
if (!is_object($overlay) || !($label = $overlay->get_label('permalink_command', 'articles', FALSE))) {
$label = i18n::c('View the page');
}
$menu[] = Skin::build_mail_button($link, $label, TRUE);
// link to the container
$link = $context['url_to_home'] . $context['url_to_root'] . $anchor->get_url();
$menu[] = Skin::build_mail_button($link, $anchor->get_title(), FALSE);
}
// finalize links
$text .= Skin::build_mail_menu($menu);
// the full message
return $text;
}
/**
* build a notification related to a section
*
* This function builds a mail message that displays:
* - an image of the contributor (if possible)
* - a headline mentioning the contribution
* - the full content of the section
* - a button linked to the section
* - a link to the containing section, if any
*
* Note: this function returns legacy HTML, not modern XHTML, because this is what most
* e-mail client software can afford.
*
* @param string either 'apply', 'create' or 'update'
* @param array attributes of the item
* @param object overlay of the item, if any
* @return string text to be send by e-mail
*/
public static function build_notification($action, $item, $overlay = NULL)
{
global $context;
// get the main anchor
$anchor = Anchors::get($item['anchor']);
// compute page title
if (is_object($overlay)) {
$title = Codes::beautify_title($overlay->get_text('title', $item));
} else {
$title = Codes::beautify_title($item['title']);
}
// headline template
switch ($action) {
case 'apply':
$template = i18n::c('%s is requesting access to %s');
break;
case 'create':
$template = i18n::c('%s has created section %s');
break;
case 'update':
$template = i18n::c('%s has updated section %s');
break;
}
// headline
$headline = sprintf($template, Surfer::get_link(), '<a href="' . Sections::get_permalink($item) . '">' . $title . '</a>');
// panel content
$content = '';
// signal restricted and private articles
if ($item['active'] == 'N') {
$title = PRIVATE_FLAG . $title;
} elseif ($item['active'] == 'R') {
$title = RESTRICTED_FLAG . $title;
}
// insert page title
$content .= '<h3><span>' . $title . '</span></h3>';
// insert anchor prefix
if (is_object($anchor)) {
$content .= $anchor->get_prefix();
}
// the introduction text, if any
if (is_object($overlay)) {
$content .= Skin::build_block($overlay->get_text('introduction', $item), 'introduction');
} elseif (isset($item['introduction']) && trim($item['introduction'])) {
$content .= Skin::build_block($item['introduction'], 'introduction');
}
// get text related to the overlay, if any
if (is_object($overlay)) {
$content .= $overlay->get_text('view', $item);
}
// filter description, if necessary
if (is_object($overlay)) {
$description = $overlay->get_text('description', $item);
} else {
$description = $item['description'];
}
// the beautified description, which is the actual page body
if ($description) {
// use adequate label
if (is_object($overlay) && ($label = $overlay->get_label('description'))) {
$content .= Skin::build_block($label, 'title');
}
// beautify the target page
$content .= Skin::build_block($description, 'description', '', $item['options']);
}
// attachment details
$details = array();
// info on related sections
if ($count = Sections::count_for_anchor('section:' . $item['id'])) {
$details[] = sprintf(i18n::nc('%d section', '%d sections', $count), $count);
}
// info on related articles
if ($count = Articles::count_for_anchor('section:' . $item['id'])) {
$details[] = sprintf(i18n::nc('%d page', '%d pages', $count), $count);
}
// info on related files
if ($count = Files::count_for_anchor('section:' . $item['id'], TRUE)) {
// the actual list of files attached to this section
if (preg_match('/\\bfiles_by_title\\b/i', $item['options'])) {
$items = Files::list_by_title_for_anchor('section:' . $item['id'], 0, 300, 'compact');
} else {
$items = Files::list_by_date_for_anchor('section:' . $item['id'], 0, 300, 'compact');
}
// wrap it with some header
if (is_array($items)) {
$items = Skin::build_list($items);
}
if ($items) {
$content .= '<h3><span>' . i18n::s('Files') . '</span></h3>' . $items;
}
// details to be displayed at page bottom
$details[] = sprintf(i18n::nc('%d file', '%d files', $count), $count);
}
// info on related links
include_once $context['path_to_root'] . 'links/links.php';
if ($count = Links::count_for_anchor('section:' . $item['id'], TRUE)) {
$details[] = sprintf(i18n::nc('%d link', '%d links', $count), $count);
}
// comments
include_once $context['path_to_root'] . 'comments/comments.php';
if ($count = Comments::count_for_anchor('section:' . $item['id'], TRUE)) {
$details[] = sprintf(i18n::nc('%d comment', '%d comments', $count), $count);
}
// describe attachments
if (count($details)) {
$content .= '<hr align="left" size=1" width="150">' . '<p style="margin: 3px 0;">' . sprintf(i18n::c('This section has %s'), join(', ', $details)) . '</p>';
}
// assemble main content of this message
$text = Skin::build_mail_content($headline, $content);
// a set of links
$menu = array();
// request access to the item
if ($action == 'apply') {
// call for action
$link = $context['url_to_home'] . $context['url_to_root'] . Sections::get_url($item['id'], 'invite', Surfer::get_id());
$label = sprintf(i18n::c('Invite %s to participate'), Surfer::get_name());
$menu[] = Skin::build_mail_button($link, $label, TRUE);
// link to user profile
$link = Surfer::get_permalink();
$label = sprintf(i18n::c('View the profile of %s'), Surfer::get_name());
$menu[] = Skin::build_mail_button($link, $label, FALSE);
// invite to visit the item
} else {
// call for action
$link = Sections::get_permalink($item);
if (!is_object($overlay) || !($label = $overlay->get_label('permalink_command', 'sections', FALSE))) {
$label = i18n::c('View the section');
}
$menu[] = Skin::build_mail_button($link, $label, TRUE);
// link to the container
if (is_object($anchor)) {
$link = $context['url_to_home'] . $context['url_to_root'] . $anchor->get_url();
$menu[] = Skin::build_mail_button($link, $anchor->get_title(), FALSE);
}
}
// finalize links
$text .= Skin::build_mail_menu($menu);
// the full message
return $text;
}
}
//
// translations based on surfer preferences
//
$context['text'] .= Skin::build_block(i18n::s('Translation to surfer language'), 'title');
// simple label
$context['text'] .= '<p>' . i18n::s('This is a simple label, according to user preference') . '</p>';
// complex label
$context['text'] .= '<p>' . sprintf(i18n::s('This string, using surfer language, allows for argument reordering: %2$s %1$s'), 'hello', 'world') . '</p>';
// plural label for one item
$context['text'] .= '<p>' . sprintf(i18n::ns('There is %d item', 'There are %d items', 1), 1) . '</p>';
// plural label for several items
$context['text'] .= '<p>' . sprintf(i18n::ns('There is %d item', 'There are %d items', 7), 7) . '</p>';
// descriptive text
$context['text'] .= i18n::s('<p>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.</p><p>Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</p>');
//
// translations based on community preferences
//
$context['text'] .= Skin::build_block(i18n::c('Translation to community language'), 'title');
// simple label, translated using community preference
$context['text'] .= '<p>' . i18n::c('This is a simple label, according to community preference') . '</p>';
// complex label, translated using community preference
$context['text'] .= '<p>' . sprintf(i18n::c('This string, using community language, allows for argument reordering: %2$s %1$s'), 'hello', 'world') . '</p>';
// plural label for one item
$context['text'] .= '<p>' . sprintf(i18n::nc('There is %d item', 'There are %d items', 1), 1) . '</p>';
// plural label for several items
$context['text'] .= '<p>' . sprintf(i18n::nc('There is %d item', 'There are %d items', 7), 7) . '</p>';
// descriptive text
$context['text'] .= i18n::c('<p>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.</p><p>Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</p>');
// render the skin
render_skin();