/**
* Return the Indicia form code
* @param array $args Input parameters.
* @param array $node Drupal node object
* @param array $response Response from Indicia services after posting a verification.
* @return HTML string
*/
public static function get_form($args, $node, $response)
{
global $user;
$logged_in = $user->uid > 0;
if (!$logged_in) {
return '<p>' . lang::get('Please log in before attempting to use this form.') . '</p>';
}
// can't really do this automatically: better to give warning
if (isset($args['locationTypeFilter'])) {
return '<p>' . lang::get('Please contact the site administrator. This version of the form uses a different method of specifying the location types.') . '</p>';
}
iform_load_helpers(array('report_helper'));
$auth = report_helper::get_read_auth($args['website_id'], $args['password']);
if (!self::set_up_survey($args, $auth)) {
return lang::get('set_up_survey returned false: survey_id missing from presets or location_type definition.');
}
$reportOptions = self::get_report_calendar_options($args, $auth);
$reportOptions['id'] = 'calendar-summary-' . $node->nid;
if (!empty($args['removable_params'])) {
self::$removableParams = get_options_array_with_user_data($args['removable_params']);
}
self::copy_args($args, $reportOptions, array('weekstart', 'weekOneContains', 'weekNumberFilter', 'outputTable', 'outputChart', 'simultaneousOutput', 'tableHeaders', 'chartLabels', 'disableableSeries', 'chartType', 'rowGroupColumn', 'rowGroupID', 'width', 'height', 'includeTableTotalRow', 'includeTableTotalColumn', 'includeChartTotalSeries', 'includeChartItemSeries', 'includeRawData', 'includeSummaryData', 'includeEstimatesData', 'summaryDataCombining', 'dataRound', 'zeroPointAnchor', 'interpolation', 'firstValue', 'lastValue', 'linkURL', 'includeRawGridDownload', 'includeRawListDownload', 'includeSummaryGridDownload', 'includeEstimatesGridDownload', 'includeListDownload', 'avgFields'));
if (isset($_GET['outputSource'])) {
$reportOptions['outputSource'] = $_GET['outputSource'];
}
if (isset($_GET['outputFormat'])) {
$reportOptions['outputFormat'] = $_GET['outputFormat'];
} else {
$reportOptions['outputFormat'] = $args['defaultOutput'];
}
if (isset($_GET['outputSeries'])) {
$reportOptions['outputSeries'] = $_GET['outputSeries'];
}
// default is all
// Advanced Chart options
$rendererOptions = trim($args['renderer_options']);
if (!empty($rendererOptions)) {
$reportOptions['rendererOptions'] = json_decode($rendererOptions, true);
}
$legendOptions = trim($args['legend_options']);
if (!empty($legendOptions)) {
$reportOptions['legendOptions'] = json_decode($legendOptions, true);
}
$axesOptions = trim($args['axes_options']);
if (!empty($axesOptions)) {
$reportOptions['axesOptions'] = json_decode($axesOptions, true);
}
if (isset($args['countColumn']) && $args['countColumn'] != '') {
$reportOptions['countColumn'] = 'attr_occurrence_' . str_replace(' ', '_', strtolower($args['countColumn']));
// assume that this is an occurrence attribute.
$reportOptions['extraParams']['occattrs'] = $args['countColumn'];
}
// for a normal user, we can only link to those samples we have created
$reportOptions['location_list'] = array();
// for a branch user, we have an allowed list of locations for which we can link to the sample.
self::$branchLocationList = array();
if (isset($args['branchManagerPermission']) && $args['branchManagerPermission'] != "" && user_access($args['branchManagerPermission'])) {
// Get list of locations attached to this user via the branch cms user id attribute
// first need to scan param_presets for survey_id..
$attrArgs = array('valuetable' => 'location_attribute_value', 'attrtable' => 'location_attribute', 'key' => 'location_id', 'fieldprefix' => 'locAttr', 'extraParams' => $auth, 'survey_id' => self::$siteUrlParams[self::$SurveyKey]);
if (isset($args['locationTypesFilter']) && $args['locationTypesFilter'] != "") {
$attrArgs['location_type_id'] = self::$siteUrlParams[self::$locationTypeKey]['value'];
}
$locationAttributes = data_entry_helper::getAttributes($attrArgs, false);
$cmsAttr = self::extract_attr($locationAttributes, $args['branchFilterAttribute']);
if (!$cmsAttr) {
return lang::get('Branch Manager location list lookup: missing Branch allocation attribute') . ' {' . print_r($attrArgs, true) . '} : ' . $args['branchFilterAttribute'];
}
$attrListArgs = array('extraParams' => array_merge(array('view' => 'list', 'website_id' => $args['website_id'], 'location_attribute_id' => $cmsAttr['attributeId'], 'raw_value' => $user->uid), $auth), 'table' => 'location_attribute_value');
$attrList = data_entry_helper::get_population_data($attrListArgs);
if (isset($attrList['error'])) {
return $attrList['error'];
}
if (count($attrList) > 0) {
foreach ($attrList as $attr) {
self::$branchLocationList[] = $attr['location_id'];
}
}
$reportOptions['location_list'] = self::$branchLocationList;
}
// for an admin, we can link to all samples.
if (isset($args['managerPermission']) && $args['managerPermission'] != "" && user_access($args['managerPermission'])) {
$reportOptions['location_list'] = 'all';
}
if (function_exists('module_exists') && module_exists('easy_login') && function_exists('hostsite_get_user_field')) {
$reportOptions['my_user_id'] = hostsite_get_user_field('indicia_user_id');
} else {
$reportOptions['my_user_id'] = $user->uid;
}
$retVal = '';
// Add controls first: set up a control bar
$retVal .= "\n<table id=\"controls-table\" class=\"ui-widget ui-widget-content ui-corner-all controls-table\"><thead class=\"ui-widget-header\"><tr>";
$retVal .= self::date_control($args, $auth, $node, $reportOptions);
$retVal .= '<th>' . self::user_control($args, $auth, $node, $reportOptions) . '</th>';
$retVal .= '<th>' . self::location_control($args, $auth, $node, $reportOptions) . '</th>';
// note this includes the location_type control if needed
$siteUrlParams = self::get_site_url_params();
if (!empty($args['removable_params'])) {
foreach (self::$removableParams as $param => $caption) {
$checked = isset($_GET[$param]) && $_GET[$param] === 'true' ? ' checked="checked"' : '';
$retVal .= '<th><input type="checkbox" name="removeParam-' . $param . '" id="removeParam-' . $param . '" class="removableParam"' . $checked . '/>' . '<label for="removeParam-' . $param . '" >' . lang::get($caption) . '</label></th>';
}
self::set_up_control_change('removeParam-' . $param, $param, array(), true);
}
// are there any params that should be set to blank using one of the removable params tickboxes?
foreach (self::$removableParams as $param => $caption) {
if (isset($_GET[$param]) && $_GET[$param] === 'true') {
$reportOptions['extraParams'][$param] = '';
}
}
if (self::$siteUrlParams[self::$userKey]['value'] == '' && self::$siteUrlParams[self::$locationKey]['value'] == '') {
$checked = self::$siteUrlParams[self::$cacheKey]['value'] === 'true' ? ' checked="checked"' : '';
$retVal .= '<th><input type="checkbox" name="cachingParam" id="cachingParam" class="cachingParam"' . $checked . '/>' . '<label for="cachingParam" title="' . lang::get("When fetching the full data set, selcting this improves performance by not going to the warehouse to get the data. Occassionally, even when selected, the data will be refreshed, which will appear to slow down the response.") . '" >' . lang::get("Use cached data") . '</label></th>';
$reportOptions['caching'] = self::$siteUrlParams[self::$cacheKey]['value'] === 'true' ? true : 'store';
self::set_up_control_change('cachingParam', self::$cacheKey, array(), true);
$checked = self::$siteUrlParams[self::$downloadKey]['value'] === 'true' ? ' checked="checked"' : '';
if (self::$siteUrlParams[self::$downloadKey]['value'] !== 'true' && isset($reportOptions['includeListDownload']) && $reportOptions['includeListDownload'] == true) {
$reportOptions['includeRawGridDownload'] = false;
$reportOptions['includeRawListDownload'] = false;
$reportOptions['includeSummaryGridDownload'] = false;
$reportOptions['includeEstimatesGridDownload'] = false;
$reportOptions['includeListDownload'] = false;
for ($i = 1; $i <= 4; $i++) {
unset($args['Download' . $i . 'Caption']);
unset($args['download_report_' . $i]);
}
data_entry_helper::$javascript .= "jQuery('.downloads-table-label').remove();\n" . "jQuery('#downloads-table thead tr').prepend('<th>" . "<label for=\"downloadParam\" title=\"" . lang::get("When fetching the full data set, unselecting this improves performance by not including the download data in the page. This extra data can lead to a significantly increase in download time.") . "\" >" . lang::get("Include Downloads") . "</label>" . "<input type=\"checkbox\" name=\"downloadParam\" id=\"downloadParam\" class=\"downloadParam\"" . $checked . "/>" . "</th>');\n";
self::set_up_control_change('downloadParam', self::$downloadKey, array(), true);
}
}
if (self::$siteUrlParams[self::$locationTypeKey]['value'] == '') {
if (isset($args['locationTypesFilter']) && $args['locationTypesFilter'] != "") {
$types = explode(',', $args['locationTypesFilter']);
$terms = self::get_sorted_termlist_terms(array('read' => $auth), 'indicia:location_types', array($types[0]));
$reportOptions['extraParams']['location_type_id'] = $terms[0]['id'];
}
} else {
$reportOptions['extraParams']['location_type_id'] = self::$siteUrlParams[self::$locationTypeKey]['value'];
}
$reportOptions['includeReportTimeStamp'] = isset($args['includeFilenameTimestamps']) && $args['includeFilenameTimestamps'];
$retVal .= '</tr></thead></table>';
$reportOptions['highlightEstimates'] = true;
$retVal .= report_helper::report_calendar_summary($reportOptions);
// upto this point the report options holds the cms user id as user_id: the report_helper converts this to the indicia
// user_id if relevant to this installation. We now need to do the same for the report links.
if (isset($reportOptions['extraParams']['user_id'])) {
$reportOptions['extraParams']['cms_user_id'] = $reportOptions['extraParams']['user_id'];
if (function_exists('module_exists') && module_exists('easy_login')) {
$account = user_load($reportOptions['extraParams']['user_id']);
if (function_exists('profile_load_profile')) {
profile_load_profile($account);
}
/* will not be invoked for Drupal7 where the fields are already in the account object */
if (isset($account->profile_indicia_user_id)) {
$reportOptions['extraParams']['user_id'] = $account->profile_indicia_user_id;
}
}
}
if (isset($args['managerPermission']) && $args['managerPermission'] != "" && user_access($args['managerPermission']) || $reportOptions['extraParams']['location_list'] != '' || $reportOptions['extraParams']['user_id'] != '') {
// if user specified - either me in normal or branch mode, or a manager
global $indicia_templates;
$indicia_templates['report_download_link'] = '<th><a href="{link}"><button type="button">{caption}</button></a></th>';
// format is assumed to be CSV
$downloadOptions = array('readAuth' => $auth, 'extraParams' => array_merge($reportOptions['extraParams'], array('date_from' => $reportOptions['date_start'], 'date_to' => $reportOptions['date_end'])), 'itemsPerPage' => false);
// there are problems dealing with location_list as an array if empty, so connvert
if ($downloadOptions['extraParams']['location_list'] == "") {
$downloadOptions['extraParams']['location_list'] = "(-1)";
} else {
$downloadOptions['extraParams']['location_list'] = '(' . $downloadOptions['extraParams']['location_list'] . ')';
}
for ($i = 1; $i <= 4; $i++) {
if (isset($args['Download' . $i . 'Caption']) && $args['Download' . $i . 'Caption'] != "" && isset($args['download_report_' . $i]) && $args['download_report_' . $i] != "") {
$downloadOptions['caption'] = $args['Download' . $i . 'Caption'];
$downloadOptions['dataSource'] = $args['download_report_' . $i];
$downloadOptions['filename'] = $reportOptions['downloadFilePrefix'] . preg_replace('/[^A-Za-z0-9]/i', '', $args['Download' . $i . 'Caption']);
$downloadOptions['filename'] .= isset($reportOptions['includeReportTimeStamp']) && $reportOptions['includeReportTimeStamp'] ? '_' . date('YmdHis') : '';
if (isset($args['download_report_' . $i . '_format'])) {
$downloadOptions['format'] = $args['download_report_' . $i . '_format'];
}
data_entry_helper::$javascript .= "\nif(jQuery('#downloads-table th').length==0)\n jQuery('#downloads-table thead tr').append('<th class=\"downloads-table-label\">" . lang::get("Downloads") . "</th>');\njQuery('#downloads-table thead tr').append('" . report_helper::report_download_link($downloadOptions) . "');\n";
}
}
}
return $retVal;
}
