Skip to content

Commit

Permalink
* Completed unit tests.
Browse files Browse the repository at this point in the history 
* Write first EditWarning class skeleton.
* Class for DatabaseConnection Mock.
* Howto: Remove redundant code and group tests.
  • Loading branch information
Thomas David committed Feb 17, 2009
1 parent a59f1c1 commit 7d46c9e
Show file tree
Hide file tree
Showing 3 changed files with 573 additions and 427 deletions.
322 changes: 20 additions & 302 deletions EditWarning.class.php
View file
@@ -1,305 +1,23 @@
<?php

class EditWarning {

/**
* This array saves all editors of a page with id, name, timestamp
* and section.
*
* @type array
* @access private
*/
private $_editors = null;

/**
* Class constructor - loads editors if article id is set.
*
* @access public
* @param article_id Article ID. (optional)
* @return true
*/
public function __construct($article_id = false) {
if ($article_id) {
$this->load($article_id);
}

return true;
}

/**
* Access-Method for $editors array.
*
* @access public
* @return array editors array.
*/
public function getEditors() {
return $this->_editors;
}

/**
* Gets all editors of a page from database.
*
* @access public
* @param int Article ID.
* @return boolean True, if no error occured.
*/
public function load($article_id) {
global $wgDBprefix;

$dbr =& wfGetDB(DB_SLAVE);
$timestamp = mktime(date("H"), date("i"), date("s"), date("m"), date("d"), date("Y"));
$query = sprintf(
"SELECT * FROM `%scurrent_edits` " .
"WHERE `page_id` = '%s' AND `timestamp` >= '%s' " .
"ORDER BY `timestamp` DESC",
$wgDBprefix,
$article_id,
$timestamp
);

if (!$result = $dbr->query($query)) {
throw new Exception("load(): Error while getting data from database.");
}

$this->_editors = array();
while ($row = $dbr->fetchObject($result)) {
$this->_editors[] = array(
'id' => $row->id,
'name' => $row->name,
'timestamp' => $row->timestamp,
'section' => $row->section
);
}

return true;
}

/**
* This method adds a user to the database.
*
* @access public
* @param article_id Article ID.
* @param user_id User ID.
* @param name User name.
* @param section ID of the section that the user is working on. (optional)
* @return boolean Return true, if no error occured.
*/
public function add($article_id, $user_id, $user_name, $timestamp, $section = 0) {
global $EditWarning_Timeout, $wgDBprefix;

$dbr =& wfGetDB(DB_MASTER);
$query = sprintf(
"INSERT `%scurrent_edits` " .
"(`page_id`, `section`, `user_id`, `user_name`, `timestamp`) VALUES " .
"('%s', '%s', '%s', '%s', '%s')",
$wgDBprefix,
$article_id,
$section,
$user_id,
$user_name,
$timestamp
);

if (!$result = $dbr->query($query)) {
throw new Exception("add(): Error while saving user to database.");
}

return true;
}

/**
* This function updates the timestamp of a editor.
*
* @access public
* @param article_id Article ID.
* @param user_id User ID.
* @return boolean Returns true, if no error occurs.
*/
public function update($article_id, $user_id) {
global $EditWarning_Timeout, $wgDBprefix;

$dbr =& wfGetDB(DB_MASTER);
$timestamp = mktime(date("H"), date("i") + $EditWarning_Timeout, date("s"), date("m"), date("d"), date("Y"));
$query = sprintf(
"UPDATE `%scurrent_edits` " .
"SET `timestamp` = '%s' " .
"WHERE `page_id` = '%s' AND `user_id` = '%s'",
$wgDBprefix,
$timestamp,
$article_id,
$user_id
);

if (!$result = $dbr->query($query)) {
throw new Exception("update(): Error while updating user timestamp.");
}

return true;
}

/**
* Removes the pagelock of an editor for a certain article.
*
* @access public
* @param int User ID.
* @param int Article ID.
* @return boolean True, if no error occured.
*/
public function remove($user_id, $article_id) {
global $wgDBprefix;

$dbr =& wfGetDB(DB_MASTER);
$query = sprintf(
"DELETE FROM `%scurrent_edits`" .
"WHERE `user_id` = '%s' AND `page_id` = '%s'",
$wgDBprefix,
$user_id,
$article_id
);

if (!$result = $dbr->query($query)) {
throw new Exception("remove(): Error while removing entry from database.");
}

return true;
}

/**
* Removes all pagelocks of an editor.
*
* @access public
* @param int User ID.
* @return boolean True, if no error occured.
*/
public function removeAll($user_id) {
global $wgDBprefix;

$dbr =& wfGetDB(DB_MASTER);
$query = sprintf(
"DELETE FROM `%scurrent_edits`" .
"WHERE `user_id` = '%s'",
$wgDBprefix,
$user_id
);

if (!$result = $dbr->query($query)) {
throw new Exception("removeAll(): Error while removing entries from database.");
}

return true;
}

/**
* Checks if someone is working on the article.
*
* @access public
* @return boolean True, if someone is working on the article, else false
*/
public function activeEditing() {
if ($this->getEditors() == null) {
throw new Exception("Error! The editors array is unset.");
}

if (count($this->getEditors()) > 0) {
return true;
} else {
return false;
}
}

/**
* Checks if someone is working on an article's section.
*
* @access public
* @return boolean True, if someone is working on an article's section, else false.
*/
public function sectionEditing() {
if ($this->getEditors() == null) {
throw new Exception("Error! The editors array is unset.");
}

foreach ($this->getEditors() as $editor) {
if ($editor['section'] != 0) {
return true;
}
}

return false;
}

/**
* Checks if a certain user is working on the article.
*
* @access public
* @param int User ID.
* @return boolean True, if the user is working on the article, else false
*/
public function isUserEditingArticle($user_id) {
if ($this->getEditors() == null) {
throw new Exception("Error! The editors array is unset.");
}

foreach ($this->getEditors() as $editor) {
if ($editor['id'] == $user_id && $editor['section'] == 0) {
return true;
}
}

return false;
}

/**
* Checks if a certain user is working on a section
*
* @access public
* @param int User ID.
* @param int Section ID.
* @return boolean True, if the user is working on the section, else false.
*/
public function isUserEditingSection($user_id, $section_id) {
if ($this->getEditors() == null) {
throw new Exception("Error! The editors array is unset.");
}

foreach ($this->getEditors() as $editor) {
if ($editor['id'] == $user_id && $editor['section'] == $section_id) {
return true;
}
}

return false;
}

/**
* Get the user working on a certain article.
*
* @access public
* @return array Array with ID, name and timestamp
*/
public function getArticleEditor() {
$editors = $this->getEditors();

if (count($editors) > 0) {
return $editors[0];
} else {
return false;
}
}

/**
* Get the user working on a certain article section.
*
* @access public
* @param int Section ID.
* @return array Array with ID, name and timestamp or false
*/
public function getSectionEditor($section_id) {
foreach ($this->getEditors() as $editor) {
if ($editor['section'] == $section_id) {
return $editor;
}
}

return false;
}
}
private $_user_id;
private $_article_id;
private $_section;
private $_article_locks;

public function __construct() {}

public function load( $db_connection, $article_id ) {}
public function getArticleID() {}
public function setArticleID() {}
public function anyLock() {}
public function articleLock() {}
public function articleUserLock() {}
public function sectionLock() {}
public function sectionUserLock() {}
public function addLock() {}
public function updateLock() {}
public function removeLock() {}
public function removeUserLocks() {}
}

0 comments on commit 7d46c9e

Please sign in to comment.