* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
* @link http://status.net/
*/
-
class NoticeTitlePlugin extends Plugin
{
+
+ // By default, notice-title widget will be available to all users.
+ // With restricted on, only users who have been granted the
+ // "richedit" role get it.
+ public $restricted = false;
+
/**
* Database schema setup
*
*
* @return boolean hook value; true means continue processing, false means stop.
*/
-
function onCheckSchema()
{
$schema = Schema::get();
// For storing titles for notices
-
- $schema->ensureTable('notice_title',
- array(new ColumnDef('notice_id', 'integer', null, true, 'PRI'),
- new ColumnDef('title', 'varchar', Notice_title::MAXCHARS, false)));
-
+ $schema->ensureTable('notice_title', Notice_title::schemaDef());
return true;
}
/**
- * Load related modules when needed
+ * Provide plugin version information.
*
- * @param string $cls Name of the class to be loaded
+ * This data is used when showing the version page.
*
- * @return boolean hook value; true means continue processing, false means stop.
+ * @param array &$versions array of version data arrays; see EVENTS.txt
+ *
+ * @return boolean hook value
*/
-
- function onAutoload($cls)
- {
- $dir = dirname(__FILE__);
-
- switch ($cls)
- {
- case 'Notice_title':
- include_once $dir . '/'.$cls.'.php';
- return false;
- default:
- return true;
- }
- }
-
function onPluginVersion(&$versions)
{
+ $url = 'http://status.net/wiki/Plugin:NoticeTitle';
+
$versions[] = array('name' => 'NoticeTitle',
'version' => NOTICE_TITLE_PLUGIN_VERSION,
'author' => 'Evan Prodromou',
- 'homepage' => 'http://status.net/wiki/Plugin:NoticeTitle',
+ 'homepage' => $url,
'rawdescription' =>
- _m('Adds optional titles to notices'));
+ // TRANS: Plugin description.
+ _m('Adds optional titles to notices.'));
return true;
}
+ /**
+ * Show title entry when showing notice form
+ *
+ * @param Form $form Form being shown
+ *
+ * @return boolean hook value
+ */
function onStartShowNoticeFormData($form)
{
- $form->out->element('input', array('type' => 'text',
- 'id' => 'notice_title',
- 'name' => 'notice_title',
- 'size' => 40,
- 'maxlength' => Notice_title::MAXCHARS,
- 'value' => _m('Title'),
- 'style' => 'color: 333333',
- 'onFocus' => 'this.value = ""; this.style = \'color: black\';'));
+ if ($this->isAllowedRichEdit()) {
+ $form->out->element('style',
+ null,
+ 'label#notice_data-text-label { display: none }');
+ $form->out->element('input', array('type' => 'text',
+ 'id' => 'notice_title',
+ 'name' => 'notice_title',
+ 'size' => 40,
+ 'maxlength' => Notice_title::MAXCHARS));
+ }
return true;
}
+ /**
+ * Validate notice title before saving
+ *
+ * @param Action $action NewNoticeAction being executed
+ * @param integer &$authorId Author ID
+ * @param string &$text Text of the notice
+ * @param array &$options Options array
+ *
+ * @return boolean hook value
+ */
function onStartNoticeSaveWeb($action, &$authorId, &$text, &$options)
{
$title = $action->trimmed('notice_title');
- if (!empty($title)) {
+ if (!empty($title) && $this->isAllowedRichEdit()) {
if (mb_strlen($title) > Notice_title::MAXCHARS) {
- throw new Exception(sprintf(_m("Notice title too long (max %d chars)", Notice_title::MAXCHARS)));
+ // TRANS: Exception thrown when a notice title is too long.
+ // TRANS: %d is the maximum number of characters allowed in a title (used for plural).
+ throw new Exception(sprintf(_m('The notice title is too long (maximum %d character).',
+ 'The notice title is too long (maximum %d characters).',
+ Notice_title::MAXCHARS),
+ Notice_title::MAXCHARS));
}
}
return true;
}
+ /**
+ * Save notice title after notice is saved
+ *
+ * @param Action $action NewNoticeAction being executed
+ * @param Notice $notice Notice that was saved
+ *
+ * @return boolean hook value
+ */
function onEndNoticeSaveWeb($action, $notice)
{
if (!empty($notice)) {
$title = $action->trimmed('notice_title');
- if (!empty($title)) {
+ if (!empty($title) && $this->isAllowedRichEdit()) {
$nt = new Notice_title();
return true;
}
- function onStartShowNoticeItem($nli)
+ /**
+ * Show the notice title in lists
+ *
+ * @param NoticeListItem $nli NoticeListItem being shown
+ *
+ * @return boolean hook value
+ */
+ function onStartShowNoticeTitle(NoticeListItem $nli)
{
$title = Notice_title::fromNotice($nli->notice);
if (!empty($title)) {
- $nli->out->element('h4', array('class' => 'notice_title'), $title);
+ $nli->elementStart('h4', array('class' => 'p-name'));
+ $nli->element('a', array('href' => $nli->notice->getUrl()), $title);
+ $nli->elementEnd('h4');
+ return false;
}
return true;
}
-}
+ /**
+ * Show the notice title in RSS output
+ *
+ * @param Notice $notice Notice being shown
+ * @param array &$entry array of values used for RSS output
+ *
+ * @return boolean hook value
+ */
+ function onEndRssEntryArray($notice, &$entry)
+ {
+ $title = Notice_title::fromNotice($notice);
+
+ if (!empty($title)) {
+ $entry['title'] = $title;
+ }
+
+ return true;
+ }
+
+ /**
+ * Show the notice title in Atom output
+ *
+ * @param Notice $notice Notice being shown
+ * @param Activity $act Activity object to be modified
+ * @param Profile $scoped Currently logged in/scoped profile
+ *
+ * @return boolean hook value
+ */
+ function onEndNoticeAsActivity(Notice $stored, Activity $act, Profile $scoped=null)
+ {
+ $title = Notice_title::fromNotice($stored);
+
+ if (!empty($title)) {
+ foreach ($act->objects as $obj) {
+ if ($obj->id == $stored->getUri()) {
+ $obj->title = $title;
+ break;
+ }
+ }
+ }
+
+ return true;
+ }
+
+ /**
+ * Remove title when the notice is deleted
+ *
+ * @param Notice $notice Notice being deleted
+ *
+ * @return boolean hook value
+ */
+ function onNoticeDeleteRelated($notice)
+ {
+ $nt = Notice_title::getKV('notice_id', $notice->id);
+
+ if (!empty($nt)) {
+ $nt->delete();
+ }
+
+ return true;
+ }
+
+ /**
+ * If a notice has a title, show it in the <title> element
+ *
+ * @param Action $action Action being executed
+ *
+ * @return boolean hook value
+ */
+ function onStartShowHeadTitle($action)
+ {
+ $actionName = $action->trimmed('action');
+
+ if ($actionName == 'shownotice') {
+ $title = Notice_title::fromNotice($action->notice);
+ if (!empty($title)) {
+ $action->element('title', null,
+ // TRANS: Page title. %1$s is the title, %2$s is the site name.
+ sprintf(_m("%1\$s - %2\$s"),
+ $title,
+ common_config('site', 'name')));
+ }
+ }
+
+ return true;
+ }
+
+ /**
+ * If a notice has a title, show it in the <h1> element
+ *
+ * @param Notice $notice Notice we're getting the title for
+ * @param string $title Reference to the variable which we set to the notice's title
+ *
+ * @return boolean hook value
+ */
+ function onGetNoticeTitle(Notice $notice, &$title)
+ {
+ $title = Notice_title::fromNotice($notice);
+ if (!is_null($title)) {
+ return false;
+ }
+
+ return true;
+ }
+
+ /**
+ * Does the current user have permission to use the notice-title widget?
+ * Always true unless the plugin's "restricted" setting is on, in which
+ * case it's limited to users with the "richedit" role.
+ *
+ * @todo FIXME: make that more sanely configurable :)
+ *
+ * @return boolean
+ */
+ private function isAllowedRichEdit()
+ {
+ if ($this->restricted) {
+ $user = common_current_user();
+ return !empty($user) && $user->hasRole('richedit');
+ } else {
+ return true;
+ }
+ }
+}
projects / quix0rs-gnu-social.git / blobdiff