Application Plugins
Application programs are pluged in and configured via the files:
- Site global applications
- /maxscape/lib/perl/Maxscape/SiteApplication.pm
/maxscape/lib/perl/Maxscape/SiteConfiguration.pm
/maxscape/lib/perl/Maxscape/SiteApplication/Page.pm
/maxscape/lib/perl/Maxscape/GlobalServerApplication.pm - Application server global applications
- /maxscape/server/'your server'/lib/perl/Maxscape/ServerApplication.pm
/maxscape/server/'your server'/lib/perl/Maxscape/ServerConfiguration.pm - Process Applications
- /maxscape/server/Maxscape/lib/perl/Maxscape/ProcessApplication.pm
Often it is wise to create some other application modules and to include them in one of the above files. For example:
# File '/maxscape/lib/perl/Maxscape/SiteConfiguration.pm': ... use your_prefix::YourModul.pm ...
Restarting the Server after a change
After changing a modul, you have to restart the server,e.g. with:
maxscape restart ; wwwerrs
or just kill the concerned FCGI process. By the way the 'wwwerrs' tcsh alias displays the log files of the apache server.
Maxscape::GlobalServerApplication Package
Maxscape::ServerApplication Package
Member Functions
- ChatRequest
- ChatWith
- CheckChatRequest
- checkProjectMemberNames
- checkProjectName
- ContextCallback
- createProject
- createProjectPages
- deleteChatFiles
- displayMainMenuHyperlink
- displayMainMenuHyperlinkFilter
- enableFinalFilter
- finalFilter
- HTTP_HeaderCallback
- initialPageGenerationCallback
- initMenu
- manageProject
- Maxscape::ServerApplication::BodyBgColor
- Maxscape::ServerApplication::ContentTypes
- Maxscape::ServerApplication::Countries
- Maxscape::ServerApplication::CountriesAsString
- Maxscape::ServerApplication::displayImage
- Maxscape::ServerApplication::displayProfileImage
- Maxscape::ServerApplication::displayUserHomePage
- Maxscape::ServerApplication::displayUserHomePage2
- Maxscape::ServerApplication::getCategoryTypes
- Maxscape::ServerApplication::getCategoryTypesContent
- Maxscape::ServerApplication::HeaderColor
- Maxscape::ServerApplication::IntroText
- Maxscape::ServerApplication::MiniChat
- Maxscape::ServerApplication::printSubCategory
- Maxscape::ServerApplication::searchUser
- MenuHeaderRule
- PageGroupPermission
- selectRandomImage
- showEncodedCategoryName
- TempChatFilePath
Synopsis
use Maxscape::ServerApplication;
Description
Examples
initialPageGenerationCallback
Synopsis
Maxscape::ServerApplication::initialPageGenerationCallback ($Page);
Description
This function can be used to do some server global actions in respect to dynamic page generation. For example, some members can be added to the server runtime's 'Page' object.
ContextCallback
Synopsis
Maxscape::ServerApplication::ContextCallback ($Context);
Description
This context callback function is set in the maxscape.conf' by the variable
$::WebServer->{"Context.InitialClientRequestCallback"}. The name is
Maxscape::ServerApplication::ContextCallback.
The function alters the name and the category of the page to be generated,
before the database is queried. To use this functionality in a page,
a page element named Object.execute is defined and its element attribute
is set to Callback="Name of the callback". The code of the callback
is defined in the Maxscape::ServerApplication::ContextCallback function,
which is stored in the file lib/perl/Maxscape/ServerApplication.pm.
enableFinalFilter
Synopsis
Maxscape::ServerApplication::enableFinalFilter ($Page);
Description
If the 'enableFinalFilter' function returns a non zero value, the 'finalFilter' function is called for the actual page content. If the function returns undef or zero the 'finalFilter' function is not called.
finalFilter
Synopsis
my $filteredText = Maxscape::ServerApplication::finalFilter ($Page, $Text);
Description
This function can be used to filter the content of a previously assambled page. The $Text parameter is a reference.
HTTP_HeaderCallback
Synopsis
my $filteredText = Maxscape::ServerApplication::HTTP_HeaderCallback ($Page, $Text);
Description
This function can be used to filter the content of a previously assambled page. The $Text parameter is a reference.
initMenu
Synopsis
my $filteredText = initMenu ($Page);
Description
PageGroupPermission
Synopsis
my $PagePermission = Maxscape::ServerApplication::PageGroupPermission
($Context, $UserData, $WebServerName);
Description
This function can be used to implement an own access rights and permission policy. Within the maXscape runtime system an access denied page is displayed if the function does not return a 'r' character (this means the page is readable).
Maxscape::ServerApplication::IntroText
Synopsis
Description
Examples
Maxscape::ServerApplication::IntroText ($Page, 'Welcome to your personal page.');
@{[Maxscape::ServerApplication::IntroText ($Page, 'Take a tour...', { ImageAlign => 'right'})]}
Maxscape::ServerApplication::printSubCategory
Synopsis
&Maxscape::ServerApplication::printSubCategory($Values);
Description
Examples
showEncodedCategoryName
Synopsis
my $ErrorText = Maxscape::ServerApplication::showEncodedCategoryName($Page, $CategoryName);
Description
Maxscape::ServerApplication::getCategoryTypes
Synopsis
&Maxscape::ServerApplication::getCategoryTypes($Page, $CategoryGroups);
Description
Examples
Maxscape::ServerApplication::getCategoryTypesContent
Synopsis
Maxscape::ServerApplication::getCategoryTypesContent($Page, $Cursor, $CategoryGroup);
Description
Examples
Maxscape::ServerApplication::BodyBgColor
Synopsis
my $BodyBgColor = &Maxscape::ServerApplication::BodyBgColor ($Page);
Description
Examples
Maxscape::ServerApplication::HeaderColor
Synopsis
my $HeaderColor = &Maxscape::ServerApplication::HeaderColor ($Page);
Description
Examples
Maxscape::ServerApplication::displayImage
Synopsis
my $HeaderColor = &Maxscape::ServerApplication::displayImage ();
Description
Examples
Maxscape::ServerApplication::displayUserHomePage
Synopsis
my $ImageLink = &Maxscape::ServerApplication::displayUserHomePage($Page, $Field, $reload, $Color);
Description
Examples
Maxscape::ServerApplication::displayUserHomePage2
Synopsis
my $ImageLink = &Maxscape::ServerApplication::displayUserHomePage2 (
$Page, $User, $LinkText, $QueryString, $ProfileType );
Description
Copied and adapted from /maxscape/server/Strinx/lib/perl/Maxscape/ServerApplication.pm
Examples
Maxscape::ServerApplication::Countries
Synopsis
my $Countries = &Maxscape::ServerApplication::Countries ($Page, $Type, $OtherCountries);
Description
Examples
Maxscape::ServerApplication::CountriesAsString
Synopsis
my $Countries = &Maxscape::ServerApplication::CountriesAsString ();
Description
Examples
Maxscape::ServerApplication::ContentTypes
Synopsis
my $ContentType = Maxscape::ServerApplication::ContentTypes ();
Description
Examples
Maxscape::ServerApplication::searchUser
Synopsis
my $Countries = &Maxscape::ServerApplication::searchUser ();
Description
Examples
ChatRequest
Synopsis
my ($lastLoginTime, $LoginTime) =
&Maxscape::ServerApplication::ChatRequest($Page);
Description
CheckChatRequest
Synopsis
my ($ChatRequestUsers) =
&Maxscape::ServerApplication::CheckChatRequest($Page);
Description
ChatWith
Synopsis
my $UserId = &Maxscape::ServerApplication::ChatWith($Page);
Description
TempChatFilePath
Synopsis
&Maxscape::ServerApplication::TempChatFilePath();
Description
deleteChatFiles
Synopsis
&Maxscape::ServerApplication::deleteChatFiles();
Description
Maxscape::ServerApplication::MiniChat
Synopsis
Maxscape::ServerApplication::MiniChat ($Page, $ChatType, $MaxSaveLines);
Description
Maxscape::ServerApplication::displayProfileImage
Synopsis
my $ImageLink = &Maxscape::ServerApplication::displayUserImage($Page, UserId => $UserId, Size => $Size, ImageRoot => $ImageRoot, CSSClass => $CSSClass, );
Description
Examples
displayMainMenuHyperlink
Synopsis
$Page->{Menu}->displayMainMenuHyperlink (Category => ${$Page->{Categories}}[$i]);
Description
Examples
MenuHeaderRule
Synopsis
Description
selectRandomImage
Synopsis
$Page->selectRandomImage ();
Description
createProject
Synopsis
$Page->createProject ($PageTreeDocumentRoot);
Description
checkProjectName
Synopsis
$Page->checkProjectName ($PageTreeDocumentRoot, $ProjectName);
Description
createProjectPages
Synopsis
$Page->createProjectPages ($PageTreeDocumentRoot, $ProjectName);
Description
manageProject
Synopsis
$Page->manageProject ($PageTreeDocumentRoot);
Description
checkProjectMemberNames
Synopsis
$Page->checkProjectMemberNames ($PageTreeDocumentRoot, $ProjectName);
Description
Synopsis
use Maxscape::ServerApplication;
Description
Examples
displayMainMenuHyperlinkFilter
Synopsis
$Page->{Menu}->displayMainMenuHyperlinkFilter (@_);
Description
Additional filter for the sites displayMainMenuHyperlink method.