data = $sql;
}
/**
* Get a new forum object for the given ID
*
* @param int $id
* @return self|false
*/
public static function newFromID( $id ) {
$dbr = MediaWikiServices::getInstance()->getDBLoadBalancer()->getConnection( DB_REPLICA );
$data = $dbr->selectRow(
'wikiforum_forums',
'*',
[ 'wff_forum' => $id ],
__METHOD__
);
if ( $data ) {
return new self( $data );
} else {
return false;
}
}
/**
* Get a new forum object from the given database row
*
* @param stdClass $sql DB row. Must be a row, not a ResultWrapper!
* @return self
*/
public static function newFromSQL( $sql ) {
return new self( $sql );
}
/**
* Get a WFForum object for the given title
*
* @param string $title title to get forum for
* @return self|false the forum, or false on failure
*/
public static function newFromName( $title ) {
$dbr = MediaWikiServices::getInstance()->getDBLoadBalancer()->getConnection( DB_REPLICA );
$data = $dbr->selectRow(
'wikiforum_forums',
'*',
[ 'wff_forum_name' => $title ],
__METHOD__
);
if ( $data ) {
return new self( $data );
} else {
return false;
}
}
/**
* Is this an annoucement forum?
*
* @return bool
*/
function isAnnouncement() {
return $this->data->wff_announcement == true;
}
/**
* Get this forum's name/title
*
* @return string Unescaped name pulled from the DB; remember to escape it yourself!
*/
function getName() {
return $this->data->wff_forum_name;
}
/**
* Show a forum's name for displaying (often in tooltips)
*
* @return string HTML-safe i18n message
*/
function showName() {
return $this->msg( 'wikiforum-forum-name', $this->getName() )->escaped();
}
/**
* Get the text/description of this forum
*
* @return string Unescaped string pulled from the DB; remember to escape it yourself!
*/
function getText() {
return $this->data->wff_description;
}
/**
* Get this forum's ID number
*
* @return int the ID
*/
function getId() {
return $this->data->wff_forum;
}
/**
* Get the timestamp of the last post in this forum
*
* @return string
*/
function getLastPostTimestamp() {
return $this->data->wff_last_post_timestamp;
}
/**
* Get the last user to have posted in this forum
*
* @return User
*/
function getLastPostUser() {
return WikiForum::getUserFromDB( $this->data->wff_last_post_actor, $this->data->wff_last_post_user_ip );
}
/**
* Get the number of threads in this forum
*
* @return int
*/
function getThreadCount() {
return $this->data->wff_thread_count;
}
/**
* Get the number of replies in the threads in this forum
*
* @return int
*/
function getReplyCount() {
return $this->data->wff_reply_count;
}
/**
* Get this forum's parent category
*
* @return WFCategory
*/
function getCategory() {
if ( !$this->category ) {
$this->category = WFCategory::newFromID( $this->data->wff_category );
}
return $this->category;
}
/**
* Get an array of this forum's children threads
*
* @param array $orderBy SQL fragment for ordering by
* @return multitype:WFThread array of threads
*/
function getThreads( $orderBy = '' ) {
if ( !$this->threads ) {
$dbr = MediaWikiServices::getInstance()->getDBLoadBalancer()->getConnection( DB_REPLICA );
$sqlThreads = $dbr->select(
'wikiforum_threads',
'*',
[ 'wft_forum' => $this->getId() ],
__METHOD__,
[ 'ORDER BY' => [ 'wft_sticky DESC', $orderBy ] ]
);
$threads = [];
foreach ( $sqlThreads as $sql ) {
$thread = WFThread::newFromSQL( $sql );
$thread->forum = $this; // saves thread making DB query to find this
$threads[] = $thread;
}
$this->threads = $threads;
}
return $this->threads;
}
/**
* Show the user and timestamp of the last post in this forum
*
* @return string
*/
function showLastPostInfo() {
if ( $this->getLastPostTimestamp() > 0 ) {
return WikiForumGui::showByInfo(
$this->getLastPostTimestamp(),
$this->getLastPostUser()
);
} else {
return '';
}
}
/**
* Get the URL to this forum
*
* @return string the URL (properly escaped and thus HTML-safe)
*/
function getURL() {
$page = SpecialPage::getTitleFor( 'WikiForum' );
return htmlspecialchars( $page->getFullURL( [ 'forum' => $this->getId() ] ) );
}
/**
* Show a link to this forum, with icon
*
* @return string HTML, the link
*/
function showLink() {
$extensionAssetsPath = $this->getConfig()->get( 'ExtensionAssetsPath' );
$icon = ' ';
return $icon . $this->showPlainLink();
}
/**
* Show a link to this forum, without icon
*
* @return string Properly escaped HTML string
*/
function showPlainLink() {
return '' . htmlspecialchars( $this->getName(), ENT_QUOTES ) . '';
}
/**
* Show an item (row) for a list (table) for this forum. The sort you find on category pages, and the overview
*
* @return string HTML, the row.
*/
function showListItem() {
$output = '
';
return $icon . $this->showPlainLink();
}
/**
* Show a link to this forum, without icon
*
* @return string Properly escaped HTML string
*/
function showPlainLink() {
return '' . htmlspecialchars( $this->getName(), ENT_QUOTES ) . '';
}
/**
* Show an item (row) for a list (table) for this forum. The sort you find on category pages, and the overview
*
* @return string HTML, the row.
*/
function showListItem() {
$output = '
';
$link = ' ' . $icon . '';
$icon = '
';
$link .= ' ' . $icon . '';
if ( $sort ) {
$icon = '
';
$link .= ' ' . $icon . '';
$icon = '
';
$link .= ' ' . $icon . '';
}
}
return $link;
}
/**
* Add a new thread to this forum
*
* @param string $title user-supplied title
* @param string $text user-supplied text
* @return WFThread|bool the thread on success, or false on failure
*/
function addThread( $title, $text ) {
return WFThread::add( $this, $title, $text );
}
/**
* Edit the forum
*
* @param string $forumName forum name as supplied by the user
* @param string $description forum description as supplied by the user
* @param bool $announcement
* @return string HTML
*/
function edit( $forumName, $description, $announcement ) {
$request = $this->getRequest();
$user = $this->getUser();
if ( !$user->isAllowed( 'wikiforum-admin' ) ) {
$error = WikiForum::showErrorMessage( 'wikiforum-error-add', 'wikiforum-error-no-rights' );
return $error . $this->show();
}
if ( strlen( $forumName ) == 0 ) {
$error = WikiForum::showErrorMessage( 'wikiforum-error-add', 'wikiforum-error-no-text-or-title' );
return $error . $this->showEditForm();
}
if ( !$user->matchEditToken( $request->getVal( 'wpToken' ) ) ) {
$error = WikiForum::showErrorMessage( 'wikiforum-error-add', 'sessionfailure' );
return $error . $this->showEditForm();
}
$dbr = MediaWikiServices::getInstance()->getDBLoadBalancer()->getConnection( DB_REPLICA );
if (
$this->getName() != $forumName ||
$this->getText() != $description ||
$this->isAnnouncement() != $announcement
) { // only update DB if anything has been changed
$dbw = MediaWikiServices::getInstance()->getDBLoadBalancer()->getConnection( DB_PRIMARY );
$dbw->update(
'wikiforum_forums',
[
'wff_forum_name' => $forumName,
'wff_description' => $description,
'wff_edited_timestamp' => $dbw->timestamp( wfTimestampNow() ),
'wff_edited_actor' => $user->getActorId(),
'wff_edited_user_ip' => $request->getIP(),
'wff_announcement' => (bool)$announcement
],
[ 'wff_forum' => $this->getId() ],
__METHOD__
);
}
$this->data->wff_forum_name = $forumName;
$this->data->wff_description = $description;
$this->data->wff_edited_timestamp = wfTimestampNow();
$this->data->wff_edited_actor = $user->getActorId();
$this->data->wff_edited_user_ip = $request->getIP();
$this->data->wff_announcement = $announcement;
return $this->show();
}
/**
* Deletes the forum
*
* @return string HTML
*/
function delete() {
$user = $this->getUser();
if ( !$user->isAllowed( 'wikiforum-admin' ) ) {
$error = WikiForum::showErrorMessage( 'wikiforum-error-delete', 'wikiforum-error-general' );
return $error . $this->show();
}
// @todo FIXME: anti-CSRF feature would go here but since the request is currently a GET
// request...
$dbw = MediaWikiServices::getInstance()->getDBLoadBalancer()->getConnection( DB_PRIMARY );
$result = $dbw->delete(
'wikiforum_forums',
[ 'wff_forum' => $this->getId() ],
__METHOD__
);
return $this->show();
}
/**
* Show this forum, including frames, headers, et al.
*
* @return string HTML the forum
*/
function show() {
$extensionAssetsPath = $this->getConfig()->get( 'ExtensionAssetsPath' );
$request = $this->getRequest();
$output = '';
$dbr = MediaWikiServices::getInstance()->getDBLoadBalancer()->getConnection( DB_REPLICA );
$specialPage = SpecialPage::getTitleFor( 'WikiForum' );
$up = '
';
$down = '
';
// Non-moderators cannot post in an announcement-only forum
if ( $this->isAnnouncement() && !$this->getUser()->isAllowed( 'wikiforum-moderator' ) ) {
$write_thread = '';
} else {
$icon = '
';
$write_thread = $icon . '' .
$this->msg( 'wikiforum-write-thread' )->escaped() . '';
}
$output .= WikiForumGui::showSearchbox();
$output .= WikiForumGui::showHeaderRow( $this->showHeaderLinks(), $this->getUser(), $write_thread );
// @todo FIXME: the logic here seems wonky from the end-users point
// of view and this code is horrible...
// The