Table Of Content

Introduction
Server Platform
Application Server
Content Generation
Kernel And API
   Runtime System
   Process
   DataBase
   WebServer
   UserData
   Context
   Page
   Elements
   Templates
   Menu
   CGI
   Form
   Table
   DirectoryTree
   Application
Manual Index
Keyword Search

Next Page | Previous Page

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

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/fcgi-bin/ProcessModules.pm
/maxscape/server/MaXscape/fcgi-bin/ProcessConfiguration.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/etc/init.d/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::ServerApplication Package

Member Functions

  1. ChatRequest
  2. ChatWith
  3. CheckChatRequest
  4. ContextCallback
  5. deleteChatFiles
  6. enableFinalFilter
  7. finalFilter
  8. HTTP_HeaderCallback
  9. initialPageGenerationCallback
  10. initMenu
  11. maXscape::ServerApplication::BodyColor
  12. maXscape::ServerApplication::Countries
  13. maXscape::ServerApplication::CountriesAsString
  14. maXscape::ServerApplication::displayImage
  15. maXscape::ServerApplication::displayProfileImage
  16. maXscape::ServerApplication::displayUserHomePage
  17. maXscape::ServerApplication::displayUserHomePage2
  18. maXscape::ServerApplication::getCategoryTypes
  19. maXscape::ServerApplication::getCategoryTypesContent
  20. maXscape::ServerApplication::HeaderColor
  21. maXscape::ServerApplication::IntroText
  22. maXscape::ServerApplication::MiniChat
  23. maXscape::ServerApplication::printSubCategory
  24. maXscape::ServerApplication::searchUser
  25. PageGroupPermission
  26. showEncodedCategoryName
  27. 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 'etc/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' is 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::BodyColor

Synopsis

my $BodyColor = &maXscape::ServerApplication::BodyColor ($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::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









Next Page Previous Page Page Top Become a Member Contact Maxscape