Yioop_V9.5_Source_Code

AdminController extends Controller
in package

Application

implements CrawlConstants

Controller used to handle admin functionalities such as modify login and password, CREATE, UPDATE,DELETE operations for users, roles, locale, and crawls

Interfaces, Classes, Traits and Enums

CrawlConstants: Shared constants and enums used by components that are involved in the crawling process

$activities : array<string|int, mixed>: Says which activities (roughly methods invoke from the web) this controller will respond to (note: more activities will be loaded from components)
$activity_component : array<string|int, mixed>: Associative array of activity => component activity is on, used by @see Controller::call method to actually invoke a given activity on a given component
$component_activities : array<string|int, mixed>: Associative array of $components activities for this controller Components are collections of activities (a little like traits) which can be reused.
$component_instances : array<string|int, mixed>: Array of instances of components used by this controller
$group_controller_activities : array<string|int, mixed>: Array of activities that should be handled by the group controller rather than the admin controller. Will redirect if detect.
$model_instances : array<string|int, mixed>: Array of instances of models used by this controller
$plugin_instances : array<string|int, mixed>: Array of instances of indexing_plugins used by this controller
$status_activities : array<string|int, mixed>: An array of activities which are periodically updated within other activities that they live. For example, within manage crawl, the current crawl status is updated every 20 or so seconds.
$view_instances : array<string|int, mixed>: Array of instances of views used by this controller
$web_site : WebSite: Stores a reference to the web server when Yioop runs in CLI mode, it acts as request router in non-CLI mode.
__construct() : mixed: Sets up component activities, instance array, and plugins.
addDifferentialPrivacy() : int: Adds to an integer, $actual_value, epsilon-noise taken from an L_1 gaussian source to centered at $actual_value to get a epsilon private, integer value.
call() : mixed: Used to invoke an activity method of the current controller or one its components
checkCSRFTime() : bool: Checks if the timestamp in $_REQUEST[$token_name] matches the timestamp of the last CSRF token accessed by this user for the kind of activity for which there might be a conflict.
checkCSRFToken() : bool: Checks if the form CSRF (cross-site request forgery preventing) token matches the given user and has not expired (1 hour till expires)
checkRequest() : bool: Checks the request if a request is for a valid activity and if it uses the correct authorization key
checkSignin() : bool: Checks whether the user name and password sent presumably by the signin form match a user in the database
clean() : string: Used to clean strings that might be tainted as originate from the user
component() : mixed: Dynamic loader for Component objects which might live on the current Component
computeComponentActivities() : array<string|int, mixed>: For a given user's access and the list component and activities return a list of translated names of components associated to a list of user accessible activities for that component
configureRequest() : mixed: If there is no profile/work directory set up then this method get called to by pass any login and go to the configure screen.
convertArrayLines() : string: Converts an array of lines of strings into a single string with proper newlines, each line having been trimmed and potentially cleaned
convertStringCleanArray() : array<string|int, mixed>: Cleans a string consisting of lines, typically of urls into an array of clean lines. This is used in handling data from the crawl options text areas. # is treated as a comment
crawlStatus() : array<string|int, mixed>: Used to handle crawlStatus REST activities requesting the status of the current web crawl
displayView() : mixed: Send the provided view to output, drawing it with the given data variable, using the current locale for translation, and writing mode
generateCSRFToken() : string: Generates a cross site request forgery preventing token based on the provided user name, the current time and the hidden AUTH_KEY
getAccessModifiers() : array<string|int, mixed>: Returns an array of the possible modifiers to the access to the activity in question.
getCSRFTime() : int: Used to return just the timestamp portion of the CSRF token
getIndexingPluginList() : mixed: Used to get a list of all available indexing plugins for this Yioop instance.
initializeAdFields() : mixed: If external source advertisements are present in the output of this controller this function can be used to initialize the field variables used to write the appropriate Javascripts
machineStatus() : array<string|int, mixed>: Gets data from the machine model concerning the on/off states of the machines managed by this Yioop instance and then passes this data the the machinestatus view.
model() : mixed: Dynamic loader for Model objects which might live on the current Controller
pagingLogic() : mixed: When an activity involves displaying tabular data (such as rows of users, groups, etc), this method might be called to set up $data fields for next, prev, and page links, it also makes the call to the model to get the row data sorted and restricted as desired. For some data sources, rather than directly make a call to the model to get the data it might be passed directly to this method.
parsePageHeadVars() : array<string|int, mixed>: Used to parse head meta variables out of a data string provided either from a wiki page or a static page. Meta data is stored in lines before the first occurrence of END_HEAD_VARS. Head variables are name=value pairs. An example of head variable might be: title = This web page's title Anything after a semi-colon on a line in the head section is treated as a comment
parsePageHeadVarsView() : mixed: Used to set up the head variables for and page_data of a wiki or static page associated with a view.
plugin() : mixed: Dynamic loader for Plugin objects which might live on the current Controller
processRequest() : mixed: This is the main entry point for handling requests to administer the Yioop/SeekQuarry site
processSession() : array<string|int, mixed>: Determines the user's current allowed activities and current activity, then calls the method for the latter.
recordViewSession() : mixed: Used to store in a session which media list items have been viewed so we can put an indicator by them when the media list is rendered
redirectLocation() : mixed: Method to perform a 301 redirect to $location in both under web server and CLI setting
redirectWithMessage() : mixed: Does a 301 redirect to the given location, sets a session variable to display a message when get there.
restoreLastSearchFromSession() : mixed: For activity involving items for which one can do search (user, group, roles) this method is used to marshal the last search that was performed out of the session when one navigates back to search
setupGraphicalCaptchaViewData() : mixed: Sets up the graphical captcha view Draws the string for graphical captcha
tableSearchRequestHandler() : mixed: Used to set up view data for table search form (might make use of $_REQUEST if form was submitted, results gotten, and we want to preserve form drop down). Table search forms are used by manageUsers, manageRoles, manageGroups, to do advanced search of the entity they are responsible for.
updateProfileFields() : mixed: Used to update the yioop installation profile based on $_REQUEST data
view() : mixed: Dynamic loader for View objects which might live on the current Controller

$activities

Says which activities (roughly methods invoke from the web) this controller will respond to (note: more activities will be loaded from components)


    public
        array<string|int, mixed>
    $activities
     = ["crawlStatus", "machineStatus", "signout"]

$activity_component

Associative array of activity => component activity is on, used by @see Controller::call method to actually invoke a given activity on a given component


    public
        array<string|int, mixed>
    $activity_component
     = []

$component_activities

Associative array of $components activities for this controller Components are collections of activities (a little like traits) which can be reused.


    public
    static    array<string|int, mixed>
    $component_activities
     = ["accountaccess" => ["manageAccount", "manageUsers", "manageRoles"], "crawl" => ["manageCrawls", "manageClassifiers", "mixCrawls", "pageOptions", "resultsEditor", "scrapers", "searchSources"], "social" => ["userMessages", "groupFeeds", "manageGroups", "wiki"], "chatbot" => ["botStory"], "store" => ["manageCredits", "manageAdvertisements"], "system" => ["manageMachines", "manageLocales", "serverSettings", "security", "appearance", "configure"]]

$component_instances

Array of instances of components used by this controller


    public
        array<string|int, mixed>
    $component_instances

$group_controller_activities

Array of activities that should be handled by the group controller rather than the admin controller. Will redirect if detect.


    public
    static    array<string|int, mixed>
    $group_controller_activities
     = ["groupFeeds", "userMessages", "wiki"]

$model_instances

Array of instances of models used by this controller


    public
        array<string|int, mixed>
    $model_instances

$plugin_instances

Array of instances of indexing_plugins used by this controller


    public
        array<string|int, mixed>
    $plugin_instances

$status_activities

An array of activities which are periodically updated within other activities that they live. For example, within manage crawl, the current crawl status is updated every 20 or so seconds.


    public
        array<string|int, mixed>
    $status_activities
     = ["crawlStatus", "machineStatus"]

$view_instances

Array of instances of views used by this controller


    public
        array<string|int, mixed>
    $view_instances
     = []

$web_site

Stores a reference to the web server when Yioop runs in CLI mode, it acts as request router in non-CLI mode.


    public
        WebSite
    $web_site

In CLI, mode it is useful for caching files in RAM as they are read

__construct()

Sets up component activities, instance array, and plugins.


    public
                    __construct([WebSite $web_site = null ]) : mixed

Parameters

$web_site : WebSite = null: is the web server when Yioop runs in CLI mode, it acts as request router in non-CLI mode. In CLI, mode it is useful for caching files in RAM as they are read

Return values

mixed —

addDifferentialPrivacy()

Adds to an integer, $actual_value, epsilon-noise taken from an L_1 gaussian source to centered at $actual_value to get a epsilon private, integer value.


    public
                    addDifferentialPrivacy(int $actual_value) : int

Parameters

$actual_value : int: number want to make private

Return values

int —

$fuzzy_value number after noise added

call()

Used to invoke an activity method of the current controller or one its components


    public
                    call(string $activity[, string $modifiers = [] ]) : mixed

Parameters

$activity : string: method to invoke
$modifiers : string = []: access modifiers to executing this method

Return values

mixed —

checkCSRFTime()

Checks if the timestamp in $_REQUEST[$token_name] matches the timestamp of the last CSRF token accessed by this user for the kind of activity for which there might be a conflict.


    public
                    checkCSRFTime(string $token_name[, string $action = "" ]) : bool

This is to avoid accidental replays of postings etc if the back button used.

Parameters

$token_name : string: name of a $_REQUEST field used to hold a CSRF_TOKEN
$action : string = "": name of current action to check for conflicts

Return values

bool —

whether a conflicting action has occurred.

checkCSRFToken()

Checks if the form CSRF (cross-site request forgery preventing) token matches the given user and has not expired (1 hour till expires)


    public
                    checkCSRFToken(string $token_name, string $user_id[, bool $use_name_as_passed = false ]) : bool

Parameters

$token_name : string: attribute of $_REQUEST containing CSRFToken
$user_id : string: user id of the user to check the token for
$use_name_as_passed : bool = false: whether to use $token_name as the token (if true) or to use $_REQUEST[$token_name]

Return values

bool —

whether the CSRF token was valid

checkRequest()

Checks the request if a request is for a valid activity and if it uses the correct authorization key


    public
                    checkRequest() : bool

Return values

bool —

whether the request was valid or not

checkSignin()

Checks whether the user name and password sent presumably by the signin form match a user in the database


    public
                    checkSignin() : bool

Return values

bool —

whether they do or not

clean()

Used to clean strings that might be tainted as originate from the user


    public
                    clean(mixed $value, mixed $type[, mixed $default = null ]) : string

Parameters

$value : mixed: tainted data
$type : mixed: type of data in value can be one of the following strings: bool, color, double, float, int, hash, or string, web-url; or it can be an array listing allowed values. If the latter, then if the value is not in the array the cleaned value will be first element of the array if $default is null
$default : mixed = null: if $value is not set default value is returned, this isn't used much since if the error_reporting is E_ALL or -1 you would still get a Notice.

Return values

string —

the clean input matching the type provided

component()

Dynamic loader for Component objects which might live on the current Component


    public
                    component(string $component) : mixed

Parameters

$component : string: name of model to return

Return values

mixed —

computeComponentActivities()

For a given user's access and the list component and activities return a list of translated names of components associated to a list of user accessible activities for that component


    public
            static        computeComponentActivities(array<string|int, mixed> $user_activities) : array<string|int, mixed>

Parameters

$user_activities : array<string|int, mixed>: a list of activities that a user is allowed to access

Return values

array<string|int, mixed> —

of translated name of component => [list of user accessible actvitities]

configureRequest()

If there is no profile/work directory set up then this method get called to by pass any login and go to the configure screen.


    public
                    configureRequest() : mixed

The configure screen is only displayed if the user is connected from localhost in this case

Return values

mixed —

convertArrayLines()

Converts an array of lines of strings into a single string with proper newlines, each line having been trimmed and potentially cleaned


    public
                    convertArrayLines(array<string|int, mixed> $arr[, string $endline_string = "
" ][, bool $clean = false ]) : string

Parameters

$arr : array<string|int, mixed>: the array of lines to be process
$endline_string : string = " ": what string should be used to indicate the end of a line
$clean : bool = false: whether to clean each line

Return values

string —

a concatenated string of cleaned lines

convertStringCleanArray()

Cleans a string consisting of lines, typically of urls into an array of clean lines. This is used in handling data from the crawl options text areas. # is treated as a comment


    public
                    convertStringCleanArray(string $str[, string $line_type = "url" ]) : array<string|int, mixed>

Parameters

$str : string: contains the url data
$line_type : string = "url": does additional cleaning depending on the type of the lines. For instance, if is "url" then a line not beginning with a url scheme will have http:// prepended.

Return values

array<string|int, mixed> —

$lines an array of clean lines

crawlStatus()

Used to handle crawlStatus REST activities requesting the status of the current web crawl


    public
                    crawlStatus() : array<string|int, mixed>

Return values

array<string|int, mixed> —

$data contains crawl status of current crawl as well as info about prior crawls and which crawl is being used for default search results

displayView()

Send the provided view to output, drawing it with the given data variable, using the current locale for translation, and writing mode


    public
                    displayView(string $view, array<string|int, mixed> $data) : mixed

Parameters

$view : string: the name of the view to draw
$data : array<string|int, mixed>: an array of values to use in drawing the view

Return values

mixed —

generateCSRFToken()

Generates a cross site request forgery preventing token based on the provided user name, the current time and the hidden AUTH_KEY


    public
                    generateCSRFToken(string $user) : string

Parameters

$user : string: username to use to generate token

Return values

string —

a csrf token

getAccessModifiers()

Returns an array of the possible modifiers to the access to the activity in question.


    public
                    getAccessModifiers(string $activity) : array<string|int, mixed>

Parameters

$activity : string: method to get access modifier list for

Return values

array<string|int, mixed> —

of string names => translated names of the access modifiers for the method in question (if any exist).

getCSRFTime()

Used to return just the timestamp portion of the CSRF token


    public
                    getCSRFTime(string $token_name) : int

Parameters

$token_name : string: name of a $_REQUEST field used to hold a CSRF_TOKEN

Return values

int —

the timestamp portion of the CSRF_TOKEN

getIndexingPluginList()

Used to get a list of all available indexing plugins for this Yioop instance.


    public
                    getIndexingPluginList() : mixed

Return values

mixed —

initializeAdFields()

If external source advertisements are present in the output of this controller this function can be used to initialize the field variables used to write the appropriate Javascripts


    public
                    initializeAdFields(array<string|int, mixed> &$data[, bool $ads_off = false ]) : mixed

Parameters

$data : array<string|int, mixed>: data to be used in drawing the view
$ads_off : bool = false: whether or not ads are turned off so that this method should do nothing

Return values

mixed —

machineStatus()

Gets data from the machine model concerning the on/off states of the machines managed by this Yioop instance and then passes this data the the machinestatus view.


    public
                    machineStatus() : array<string|int, mixed>

Return values

array<string|int, mixed> —

$data MACHINES field has information about each machine managed by this Yioop instance as well the on off status of its queue_servers and fetchers. The REFRESH field is used to tell the controller that the view shouldn't have its own sidemenu.

model()

Dynamic loader for Model objects which might live on the current Controller


    public
                    model(string $model) : mixed

Parameters

$model : string: name of model to return

Return values

mixed —

pagingLogic()

When an activity involves displaying tabular data (such as rows of users, groups, etc), this method might be called to set up $data fields for next, prev, and page links, it also makes the call to the model to get the row data sorted and restricted as desired. For some data sources, rather than directly make a call to the model to get the data it might be passed directly to this method.


    public
                    pagingLogic(array<string|int, mixed> &$data, mixed $field_or_model, string $output_field, int $default_show[, array<string|int, mixed> $search_array = [] ][, string $var_prefix = "" ][, array<string|int, mixed> $args = null ]) : mixed

Parameters

$data : array<string|int, mixed>: used to send data to the view will be updated by this method with row and paging data
$field_or_model : mixed: if an object, this is assumed to be a model and so the getRows method of this model is called to get row data, sorted and restricted according to $search_array; if a string then the row data is assumed to be in $data[$field_or_model] and pagingLogic itself does the sorting and restricting.
$output_field : string: output rows for the view will be stored in $data[$output_field]
$default_show : int: if not specified by $_REQUEST, then this will be used to determine the maximum number of rows that will be written to $data[$output_field]
$search_array : array<string|int, mixed> = []: used to sort and restrict in the getRows call or the data from $data[$field_or_model]. Each element of this is a quadruple name of a field, what comparison to perform, a value to check, and an order (ascending/descending) to sort by
$var_prefix : string = "": if there are multiple uses of pagingLogic presented on the same view then $var_prefix can be prepended to to the $data field variables like num_show, start_row, end_row to distinguish between them
$args : array<string|int, mixed> = null: additional arguments that are passed to getRows and in turn to selectCallback, fromCallback, and whereCallback that might provide user_id, etc to further control which rows are returned

Return values

mixed —

parsePageHeadVars()

Used to parse head meta variables out of a data string provided either from a wiki page or a static page. Meta data is stored in lines before the first occurrence of END_HEAD_VARS. Head variables are name=value pairs. An example of head variable might be: title = This web page's title Anything after a semi-colon on a line in the head section is treated as a comment


    public
                    parsePageHeadVars(string $page_data[, mixed $with_body = false ]) : array<string|int, mixed>

Parameters

$page_data : string: this is the actual content of a wiki or static page
$with_body : mixed = false

Return values

array<string|int, mixed> —

the associative array of head variables or pair [head vars, page body]

parsePageHeadVarsView()

Used to set up the head variables for and page_data of a wiki or static page associated with a view.


    public
                    parsePageHeadVarsView(object $view, string $page_name, string $page_data) : mixed

Parameters

$view : object: View on which page data will be rendered
$page_name : string: a string name/id to associate with page. For example, might have 404 for a page about 404 errors
$page_data : string: this is the actual content of a wiki or static page

Return values

mixed —

plugin()

Dynamic loader for Plugin objects which might live on the current Controller


    public
                    plugin(string $plugin) : mixed

Parameters

$plugin : string: name of Plugin to return

Return values

mixed —

processRequest()

This is the main entry point for handling requests to administer the Yioop/SeekQuarry site


    public
                    processRequest() : mixed

ProcessRequest determines the type of request (signin , manageAccount, etc) is being made. It then calls the appropriate method to handle the given activity. Finally, it draws the relevant admin screen

Return values

mixed —

processSession()

Determines the user's current allowed activities and current activity, then calls the method for the latter.


    public
                    processSession() : array<string|int, mixed>

This is called from once a user is logged in.

Return values

array<string|int, mixed> —

$data the results of doing the activity for display in the view

recordViewSession()

Used to store in a session which media list items have been viewed so we can put an indicator by them when the media list is rendered


    public
                    recordViewSession(int $page_id, string $sub_path, string $media_name) : mixed

Parameters

$page_id : int: the id of page with media list
$sub_path : string: the resource folder on that page
$media_name : string: item to store indiicator into session for

Return values

mixed —

redirectLocation()

Method to perform a 301 redirect to $location in both under web server and CLI setting


    public
                    redirectLocation(string $location) : mixed

Parameters

$location : string: url to redirect to

Return values

mixed —

redirectWithMessage()

Does a 301 redirect to the given location, sets a session variable to display a message when get there.


    public
                    redirectWithMessage(string $message[, string $copy_fields = false ][, bool $restart = false ][, bool $use_base_url = false ]) : mixed

Parameters

$message : string: message to write
$copy_fields : string = false: $_REQUEST fields to copy for redirect
$restart : bool = false: if yioop is being run as its own server rather than under apache whether to restart this server.
$use_base_url : bool = false: set true if the base_url be included in the redirect

Return values

mixed —

restoreLastSearchFromSession()

For activity involving items for which one can do search (user, group, roles) this method is used to marshal the last search that was performed out of the session when one navigates back to search


    public
                    restoreLastSearchFromSession(array<string|int, mixed> &$data, string $activity[, string $field_postfix = "" ]) : mixed

Parameters

$data : array<string|int, mixed>: field variables used by view to draw itself
$activity : string: current activity marshalling last search for
$field_postfix : string = "": some activities support multiple search forms. The field postfix is used to select among these.

Return values

mixed —

setupGraphicalCaptchaViewData()

Sets up the graphical captcha view Draws the string for graphical captcha


    public
                    setupGraphicalCaptchaViewData(array<string|int, mixed> &$data) : mixed

Parameters

$data : array<string|int, mixed>: used by view to draw any dynamic content in this case we append a field "CAPTCHA_IMAGE" with a data url of the captcha to draw.

Return values

mixed —

tableSearchRequestHandler()

Used to set up view data for table search form (might make use of $_REQUEST if form was submitted, results gotten, and we want to preserve form drop down). Table search forms are used by manageUsers, manageRoles, manageGroups, to do advanced search of the entity they are responsible for.


    public
                    tableSearchRequestHandler(array<string|int, mixed> &$data, mixed $activity[, array<string|int, mixed> $comparison_fields = [] ][, string $field_postfix = "" ]) : mixed

Parameters

$data : array<string|int, mixed>: modified to contain the field data needed for the view to draw the search form
$activity : mixed
$comparison_fields : array<string|int, mixed> = []: those fields of the entity in question ( for example, users) which we can search both with string comparison operators and equality operators
$field_postfix : string = "": suffix to append onto field names in case there are multiple forms on the same page

Return values

mixed —

updateProfileFields()

Used to update the yioop installation profile based on $_REQUEST data


    public
                    updateProfileFields(array<string|int, mixed> &$data, array<string|int, mixed> &$profile[, array<string|int, mixed> $check_box_fields = [] ]) : mixed

Parameters

$data : array<string|int, mixed>: field data to be sent to the view
$profile : array<string|int, mixed>: used to contain the current and updated profile field values
$check_box_fields : array<string|int, mixed> = []: fields whose data comes from a html checkbox

Return values

mixed —

view()

Dynamic loader for View objects which might live on the current Controller


    public
                    view(string $view) : mixed

Parameters

$view : string: name of view to return

Return values

mixed —

AdminController extends Controller in package Application implements CrawlConstants

Tags

Interfaces, Classes, Traits and Enums

Table of Contents

Properties

$activities

$activity_component

$component_activities

$component_instances

$group_controller_activities

$model_instances

$plugin_instances

$status_activities

$view_instances

$web_site

Methods

__construct()

Parameters

Return values

addDifferentialPrivacy()

Parameters

Return values

call()

Parameters

Return values

checkCSRFTime()

Parameters

Return values

checkCSRFToken()

Parameters

Return values

checkRequest()

Return values

checkSignin()

Return values

clean()

Parameters

Return values

component()

Parameters

Return values

computeComponentActivities()

Parameters

Return values

configureRequest()

Return values

convertArrayLines()

Parameters

Return values

convertStringCleanArray()

Parameters

Return values

crawlStatus()

Return values

displayView()

Parameters

Return values

generateCSRFToken()

Parameters

Return values

getAccessModifiers()

Parameters

Return values

getCSRFTime()

Parameters

Return values

getIndexingPluginList()

Return values

initializeAdFields()

Parameters

Return values

machineStatus()

Return values

model()

Parameters

Return values

pagingLogic()

Parameters

Return values

parsePageHeadVars()

AdminController extends Controller
in package

Application

implements CrawlConstants