sClass = $sClass; $this->sTitle = $sTitle; $this->iId = $iId; $this->oMultiPage = new MultiPage(FALSE); $this->oTableRow = new OMTableRow(null); // initialize the common responses array $this->aCommonResponses = array(); $this->aCommonResponses[] = "Thank you for your submission."; $this->aCommonResponses[] = "Please move crash/debug output to a bug". " in Wine's Bugzilla at http://bugs.winehq.org and resubmit."; $this->aCommonResponses[] = "We appreciate your submission but it". " needs to be more detailed before it will be most useful to other users of". " the Application Database.". " Please try to improve the entry and resubmit."; $this->aCommonResponses[] = "We appreciate your submission but it". " requires improvement to its grammar and/or spelling". " before it will be most useful to other users of". " the Application Database.". " Please try to improve the entry and resubmit."; $this->aCommonResponses[] = "Please do not copy large amount of text from". " the program's website"; } /* Check whether the associated class has the given method */ function checkMethod($sMethodName, $bEnableOutput) { // NOTE: we only 'new' here because php4 requires an instance // of an object as the first argument to method_exists(), php5 // doesn't if(!method_exists(new $this->sClass(), $sMethodName)) { if($bEnableOutput) echo "class '".$this->sClass."' lacks method '".$sMethodName."'\n"; return false; } return true; } /* Check whether the specified methods are valid */ function checkMethods($aMethods, $bExit = true) { foreach($aMethods as $sMethod) { if(!$this->checkMethod($sMethod, false)) { echo "Selected class does not support this operation ". "(missing '$sMethod()')\n"; if($bExit) exit; else return FALSE; } } return TRUE; } /* displays the list of entries */ function display_table($aClean) { $this->checkMethods(array("ObjectGetEntries", "ObjectGetHeader", "objectGetTableRow", "objectGetId", "canEdit")); /* We cannot process a queue if we are not logged in */ if(!$_SESSION['current']->isLoggedIn() && $this->bIsQueue) { $sQueueText = $this->bIsRejected ? "rejected" : "queued"; echo '
You need to '; echo "log in in order to process $sQueueText entries
\n"; return; } $oObject = new $this->sClass(); /* Display selectors for items per page and current page, if applicable. The function returns FALSE or an array of arguments to be passed to objectGetEntries() */ $this->handleMultiPageControls($aClean, TRUE); /* query the class for its entries */ /* We pass in $this->bIsQueue to tell the object */ /* if we are requesting a list of its queued objects or */ /* all of its objects */ if($this->oMultiPage->bEnabled) { $hResult = $oObject->objectGetEntries($this->bIsQueue, $this->bIsRejected, $this->oMultiPage->iItemsPerPage, $this->oMultiPage->iLowerLimit); } else { $hResult = $oObject->objectGetEntries($this->bIsQueue, $this->bIsRejected); } /* did we get any entries? */ if(!$hResult || mysql_num_rows($hResult) == 0) { switch($this->getQueueString($this->bIsQueue, $this->bIsRejected)) { case "true": echo "
The queue for '$this->sClass' is empty
"; break; case "false": echo "
No entries of '$this->sClass' are present
"; break; case "rejected": echo "
No rejected entries of '$this->sClass' are ". "present
"; break; } echo "
makeUrl("add", false, "Add $this->sClass entry")."\">Add an entry?
"; return; } /* output the header */ echo ''; /* Output header cells */ $this->outputHeader("color4"); /* output each entry */ for($iCount = 0; $oRow = mysql_fetch_object($hResult); $iCount++) { $oObject = new $this->sClass(null, $oRow); $this->oTableRow = $oObject->objectGetTableRow(); $sColor = ($iCount % 2) ? "color0" : "color1"; //TODO: we shouldn't access this method directly, should make an accessor for it if(!$this->oTableRow->oTableRow->sClass) { $this->oTableRow->oTableRow->SetClass($sColor); } // if this row is clickable, make it highlight appropirately $oTableRowClick = $this->oTableRow->oTableRow->oTableRowClick; if($oTableRowClick) { $oTableRowHighlight = GetStandardRowHighlight($iCount); $oTableRowClick->SetHighlight($oTableRowHighlight); } $sEditLinkLabel = $this->bIsQueue ? "process" : "edit"; /* We add some action links */ if($oObject->canEdit()) { $shDeleteLink = ""; if($this->oTableRow->bHasDeleteLink) { $shDeleteLink = ' [ objectGetid()). '">delete ]'; } $oTableCell = new TableCell('[ objectGetId()).'">'.$sEditLinkLabel.' ]'.$shDeleteLink); $this->oTableRow->AddCell($oTableCell); } echo $this->oTableRow->GetString(); } echo "
"; $oObject = new $this->sClass(); if($oObject->canEdit()) { echo "

makeUrl("add", false, "Add $this->sClass")."\">Add entry\n"; } } /* display the entry for editing */ function display_entry_for_editing($sBackLink, $sErrors) { $this->checkMethods(array("outputEditor", "getOutputEditorValues", "update", "create")); // open up the div for the default container echo "
\n"; // link back to the previous page echo html_back_link(1, $sBackLink); $oObject = new $this->sClass($this->iId); /* The entry does not exist */ if(!$oObject->objectGetId()) { echo "There is no entry with that id in the database.\n"; echo "
"; return; } /* Display errors, if any, and fetch form data */ if($this->displayErrors($sErrors)) { global $aClean; $oObject->getOutputEditorValues($aClean); } echo '
iId). '" method="post" enctype="multipart/form-data">',"\n"; echo ''; echo ''; echo ''; echo ''; echo ''; $oObject->outputEditor(); /* if this is a queue add a dialog for replying to the submitter of the queued entry */ if($this->bIsQueue) { /* If it isn't implemented, that means there is no default text */ if(method_exists(new $this->sClass, "getDefaultReply")) $sDefaultReply = $oObject->getDefaultReply(); echo html_frame_start("Reply text", "90%", "", 0); echo "\n"; echo '',"\n"; echo '',"\n"; ///////////////////////////////////////////////// // output radio buttons for some common responses echo '',"\n"; // NOTE: We use the label tag so the user can click anywhere in // the text of the radio button to select the radio button. // Otherwise the user has to click on the very small circle portion // of the button to select it foreach($this->aCommonResponses as $iIndex => $sReply) { echo '',"\n"; echo '',"\n"; echo '',"\n"; } // end output radio buttons for common responses ///////////////////////////////////////////////// /* buttons for operations we can perform on this entry */ echo '',"\n"; echo '
email Text
'. 'Common replies
Email '. APPDB_OWNER_EMAIL.' if you want to suggest a new common reply.
' ,"\n"; echo '',"\n"; if(!method_exists(new $this->sClass, "objectHideDelete")) { echo '',"\n"; } if(!$this->bIsRejected) { echo '',"\n"; } echo '',"\n"; echo '
'; echo html_frame_end(); } else { echo '',"\n"; echo ''. ' ',"\n"; echo "\n"; } echo '
'; echo "\n"; } /* Display help for queue processing */ function display_queue_processing_help() { /* No help text defined, so do nothing */ if(!method_exists(new $this->sClass(), "ObjectDisplayQueueProcessingHelp")) return FALSE; call_user_func(array($this->sClass, "ObjectDisplayQueueProcessingHelp")); } /* Delete the object associated with the given id */ function delete_entry() { $this->checkMethods(array("delete", "canEdit")); $oObject = new $this->sClass($this->iId); if(!$oObject->canEdit()) return FALSE; if($oObject->delete()) util_redirect_and_exit($this->makeUrl("view", false)); else echo "Failure.\n"; } /* Move all the object's children to another object of the same type, and delete the original object afterwards */ function move_children($iNewId) { $oObject = new $this->sClass($this->iId); $oNewObject = new $this->sClass($iNewId); /* The user needs to have edit rights to both the old and the new object If you have edit rights to an object then you should have edit rights to its child objects as well */ if(!$oObject->canEdit() || !$oNewObject->canEdit()) return FALSE; $iAffected = $oObject->objectMoveChildren($iNewId); if($iAffected) { $sPlural = ($iAffected == 1) ? "": "s"; addmsg("Moved $iAffected child object$sPlural", "green"); } else if($iAfffected === FALSE) { /* We don't want to delete this object if some children were not moved */ addmsg("Failed to move child objects", "red"); return FALSE; } $this->delete_entry(); } /* Display a page where the user can select which object the children of the current object can be moved to */ function display_move_children() { $oObject = new $this->sClass($this->iId); if(!$oObject->canEdit()) { echo "Insufficient privileges.
\n"; return FALSE; } /* We only allow moving to non-queued objects */ if(!$hResult = $oObject->objectGetEntries(false, false)) { echo "Failed to get list of objects.
\n"; return FALSE; } /* Display some help text */ echo "

Move all child objects of ".$oObject->objectMakeLink()." to the entry "; echo "selected below, and delete ".$oObject->objectMakeLink()." afterwards.

\n"; echo "\n"; echo html_tr(array( "Name", "Move here"), "color4"); for($i = 0; $oRow = mysql_fetch_object($hResult); $i++) { $oCandidate = new $this->sClass(null, $oRow); if($oCandidate->objectGetId() == $this->iId) { $i++; continue; } echo html_tr(array( $oCandidate->objectMakeLink(), "makeUrl("moveChildren", $this->iId). "&iNewId=".$oCandidate->objectGetId()."\">Move here"), ($i % 2) ? "color0" : "color1"); } echo "
\n"; } /* Display screen for submitting a new entry of given type */ function add_entry($sBackLink, $sErrors = "") { $this->checkMethods(array("outputEditor", "getOutputEditorValues", "update", "create")); $oObject = new $this->sClass(); echo "
\n"; /* Display errors, if any, and fetch form data */ if($this->displayErrors($sErrors)) { global $aClean; $oObject->getOutputEditorValues($aClean); } /* Display help if it is exists */ if(method_exists(new $this->sClass, "objectDisplayAddItemHelp")) $oObject->objectDisplayAddItemHelp(); echo "
\n"; $oObject->outputEditor(); echo "\n"; echo "sTitle\" />\n"; echo "
"; echo "\n"; echo "
\n"; echo html_back_link(1, $sBackLink); echo "
\n"; } function handle_anonymous_submission() { $oObject = new $this->sClass(); if($oObject->allowAnonymousSubmissions() || $_SESSION['current']->isLoggedIn()) return; util_show_error_page_and_exit("You need to be logged in. If you don’t have an ". "account you can register ". "now, it only takes a few seconds."); } /* View an entry */ function view($sBackLink) { $this->checkMethods(array("display")); $oObject = new $this->sClass($this->iId); /* Display a link to the move child objects page if the class has the necessary functions and the user has edit rights. Not all classes have child objects. */ if(method_exists($oObject, "objectMoveChildren") && method_exists($oObject, "objectGetId") && $oObject->canEdit()) { echo "makeUrl("showMoveChildren", $this->iId, "Move Child Objects")."\">Move child objects

\n"; } $oObject->display(); echo html_back_link(1, $sBackLink); } /* Process form data generated by adding or updating an entry */ function processForm($aClean) { // FIXME: hack so if we modify $aClean in here any objects that use the global // $aClean will see the modified value. Should be replaced when we have // general purpose objectManager email code in place since the sReplyText value // is the value we modify and we'll be passing that into methods in the future global $aClean; if(!isset($aClean['sSubmit'])) return; $this->checkMethods(array("getOutputEditorValues", "update", "create", "canEdit")); $this->iId = $this->getIdFromInput($aClean); $oObject = new $this->sClass($this->iId); /* If it isn't implemented, that means there is no default text */ if(method_exists(new $this->sClass, "getDefaultReply")) { /* Don't send the default reply text */ if($oObject->getDefaultReply() == $aClean['sReplyText']) $aClean['sReplyText'] = ""; } // handle the common response radio button value // if sReplyText is empty, if sOMCommonReply was set because // the user selected a radio button then use that text instead if( isset($aClean['sReplyText']) && $aClean['sReplyText'] == "" && isset($aClean['sOMCommonReply'])) { $aClean['sReplyText'] = $aClean['sOMCommonReply']; } $oObject->getOutputEditorValues($aClean); /* Check input, if necessary */ if(method_exists(new $this->sClass, "checkOutputEditorInput")) { $sErrors = $oObject->checkOutputEditorInput($aClean); if($sErrors) return $sErrors; } switch($aClean['sSubmit']) { case "Submit": // if we have a valid iId then we are displaying an existing entry // otherwise we should create the entry in the 'else' case if($this->iId) { if(!$oObject->canEdit()) return FALSE; if($this->bIsRejected) $oObject->ReQueue(); if($this->bIsQueue && !$oObject->mustBeQueued()) $oObject->unQueue(); $oObject->update(); } else { $this->handle_anonymous_submission(); $oObject->create(); } break; case "Reject": if(!$oObject->canEdit()) return FALSE; $oObject->reject(); break; case "Delete": $this->delete_entry(); } /* Displaying the entire un-queued list for a class is not a good idea, so only do so for queued data */ if($this->bIsQueue) $sRedirectLink = $this->makeUrl("view", false, "$this->sClass list"); else $sRedirectLink = APPDB_ROOT; util_redirect_and_exit($sRedirectLink); return TRUE; } /* Make an objectManager URL based on the object and optional parameters */ function makeUrl($sAction = false, $iId = false, $sTitle = false) { $sUrl = APPDB_ROOT."objectManager.php?"; $sIsQueue = $this->bIsQueue ? "true" : "false"; $sUrl .= "bIsQueue=$sIsQueue"; $sIsRejected = $this->bIsRejected ? "true" : "false"; $sUrl .= "&bIsRejected=$sIsRejected"; $sUrl .= "&sClass=".$this->sClass; if($iId) $sUrl .= "&iId=$iId"; if($sAction) $sUrl .= "&sAction=$sAction"; if(!$sTitle) $sTitle = $this->sTitle; $sUrl .= "&sTitle=".urlencode($sTitle); if($this->oMultiPage->bEnabled) { $sUrl .= "&iItemsPerPage=".$this->oMultiPage->iItemsPerPage; $sUrl .= "&iPage=".$this->oMultiPage->iPage; } return $sUrl; } /* Inserts the information in an objectManager object as form data, so that it is preserved when submitting forms */ function makeUrlFormData() { $sIsQueue = $this->bIsQueue ? "true" : "false"; $sIsRejected = $this->bIsRejected ? "true" : "false"; $sReturn = "\n"; $sReturn .= "\n"; $sReturn .= "sClass."\" />\n"; $sReturn .= "sTitle."\" />\n"; if($this->oMultiPage->bEnabled) { $sReturn .= "oMultiPage->iItemsPerPage."\" />\n"; $sReturn .= "oMultiPage->iPage."\" />\n"; } return $sReturn; } /* Get id from form data */ function getIdFromInput($aClean) { $sId = "i".ucfirst($this->sClass)."Id"; $iId = isset($aClean['sId']) ? $aClean['sId'] : $aClean['iId']; return $iId; } /* Output headers for a table */ function outputHeader($sClass) { $oObject = new $this->sClass(); $aCells = $oObject->objectGetHeader(); /* Add an action column if the user can edit this class, or if it is a queue. Even though a user annot process items, he can edit his queued submissions */ if($oObject->canEdit() || $this->bIsQueue) $aCells[] = "Action"; echo html_tr($aCells, $sClass); } function handleMultiPageControls($aClean, $bItemsPerPageSelector = TRUE) { /* Display multi-page browsing controls (prev, next etc.) if applicable. objectGetItemsPerPage returns FALSE if no multi-page display should be used, or an array of options, where the first element contains an array of items per page values and the second contains the default value. If the function does not exist we assume no multi-page behaviour */ $oObject = new $this->sClass(); if(!method_exists($oObject, "objectGetItemsPerPage") || $oObject->objectGetItemsPerPage($this->bIsQueue) === FALSE) { /* Do not enable the MultiPage controls */ $this->oMultiPage->MultiPage(FALSE); return; } $aReturn = $oObject->objectGetItemsPerPage($this->bIsQueue); $aItemsPerPage = $aReturn[0]; $iDefaultPerPage = $aReturn[1]; $iItemsPerPage = $iDefaultPerPage; if ( isset($aClean['iItemsPerPage']) && in_array($aClean['iItemsPerPage'], $aItemsPerPage) ) $iItemsPerPage = $aClean['iItemsPerPage']; $sControls = "
makeUrl()."\" method=\"get\">"; /* Fill in form data for the objectManager URL */ $sControls .= $this->makeUrlFormData(); $sControls .= "

 Items per page"; $sControls .= ""; $sControls .= "   "; $sControls .= "

"; $iTotalEntries = $oObject->objectGetEntriesCount($this->bIsQueue, $this->bIsRejected); $iNumPages = ceil($iTotalEntries / $iItemsPerPage); if($iNumPages == 0) $iNumPages = 1; /* Check current page value */ $iPage = isset($aClean['iPage']) ? $aClean['iPage'] : 1; $iCurrentPage = min($iPage, $iNumPages); /* Display selectors and info */ echo '
'; echo "Page $iPage of $iNumPages
"; /* Page controls */ $iPageRange = 7; // the number of page links we want to display display_page_range($iPage, $iPageRange, $iNumPages, $this->makeUrl()."&iItemsPerPage=$iItemsPerPage"); echo $sControls; /* Fill the MultiPage object with the LIMIT related values */ $iLowerLimit = ($iPage - 1) * $iItemsPerPage; $this->oMultiPage->MultiPage(TRUE, $iItemsPerPage, $iLowerLimit); $this->oMultiPage->iPage = $iPage; } function getQueueString($bQueued, $bRejected) { if($bQueued) { if($bRejected) $sQueueString = "rejected"; else $sQueueString = "true"; } else $sQueueString = "false"; return $sQueueString; } function displayErrors($sErrors) { if($sErrors) { /* A class's checkOutputEditorInput() may simply return TRUE if it wants the editor to be displayed again, without any error messages. This is for example useful when gathering information in several steps, such as with application submission */ if($sErrors === TRUE) return TRUE; echo "\n"; echo "The following errors were found
\n"; echo "\n"; echo "
"; return TRUE; } else return FALSE; } } class MultiPage { var $iItemsPerPage; var $iLowerLimit; /* Internal; set by handleMultiPageControls. We use iPage in the URls */ var $iPage; var $bEnabled; function MultiPage($bEnabled = FALSE, $iItemsPerPage = 0, $iLowerLimit = 0) { $this->bEnabled = $bEnabled; $this->iItemsPerPage = $iItemsPerPage; $this->iLowerLimit = $iLowerLimit; } function getDataFromInput($aClean) { if(isset($aClean['iItemsPerPage']) && isset($aClean['iPage'])) $this->bEnabled = TRUE; else return; $this->iItemsPerPage = $aClean['iItemsPerPage']; $this->iPage = $aClean['iPage']; } } ?>