Skip to content
GitLab
Commit 0f4c7646 authored by metzlerd's avatar metzlerd
Browse files

Major update with ui refactor. 

Adding help.
#837968 Fixed distributed reports not copying in sub directories.
parent a53d8f5b
Expand all Hide whitespace changes
Inline Side-by-side
FrxDataEngine.inc → FrxDataProvider.inc
View file @ 0f4c7646
......@@ -6,14 +6,14 @@ require_once('forena.common.inc');
* Class that defines default methods for access control in an FrxDataEngine
*
*/
class FrxDataEngine{
class FrxDataProvider{
public $conf;
public $block_path;
public $comment_prefix;
public $comment_suffix;
public $comment_suffix;
public $block_ext;
protected $te;
public function __construct($conf, $repos_path) {
$this->conf = $conf;
$this->comment_prefix = '--';
......@@ -38,10 +38,44 @@ class FrxDataEngine{
}
}
/**
* Default block load
* Loads the data block based on the block name from the file system. The classes that
* are derived from this will set the block_ext property, which in most cases is .sql but
* might be something different. The load of the block file should return data, access and
* probably parameters to.
* @param unknown_type $block_name
* @return unknown
*/
public function load_block($block_name) {
$filename = $this->block_path .'/'. $block_name .'.'. $this->block_ext;
$block = forena_load_block_file($filename, $this->comment_prefix, $this->comment_suffix);
$block = forena_load_block_file($filename, $this->comment_prefix, $this->comment_suffix);
// If we have a regular expression token parser, then get the tokens out of the block.
if ($this->te) {
$tokens = $this->te->tokens($block['source']);
$block['tokens'] = $tokens;
}
return $block;
}
/**
* Find all the blocks matching a provided search string
*
* @param string $search part block names to search for
* @return unknown
*/
public function list_blocks($search) {
$block_list = array();
// First find files that match the search string
$path = $this->block_path. '/*'. $search . '*.' . $this->block_ext;
$d = glob($path);
foreach ($d as $file_name) {
list($block_name, $ext) = explode('.', $file_name);
$block_list[] = str_replace($this->block_path .'/','',$block_name);
}
return $block_list;
}
}
\ No newline at end of file
FrxReport.inc
View file @ 0f4c7646
......@@ -2,7 +2,7 @@
// $Id$
/**
* @file
* Basic report engine. Controls the rendering of the report.
* Basic report provider. Controls the rendering of the report.
*/
define('FRX_NS', 'urn:FrxReports');
require_once('FrxSyntaxEngine.inc');
......@@ -60,9 +60,9 @@ class FrxReport {
$this->form = (string) $value;
break;
case 'parameters':
foreach ($node->children(FRX_NS) as $key => $node) {
foreach ($node->children(FRX_NS) as $key => $node) {
$parm = array();
foreach ($node->attributes() as $akey => $attr) {
foreach ($node->attributes() as $akey => $attr) {
$parm[$akey] = (string)$attr;
}
$parm['value']= (string)$node;
......@@ -86,7 +86,7 @@ class FrxReport {
*/
private function get_data($block, $clause='') {
//@TODO: Merge xml data parameters into the report paramters
$this->cur_data = forena_invoke_data_engine($block, $this->cur_data, $clause);
$this->cur_data = forena_invoke_data_provider($block, $this->cur_data, $clause);
if ($this->cur_data) $this->blocks_loaded = TRUE;
}
......@@ -187,7 +187,7 @@ class FrxReport {
}
/*
* Formatter used by the syntax engine to alter data that gets extracted.
* This invokes the field translation engine
* This invokes the field translation
*/
public function format($value, $key, $data) {
// Determine if there is a field overide entry
......@@ -230,7 +230,7 @@ class FrxReport {
* @return unknown_type
*/
public function deleteNode($id) {
$path = '//*[@id="'. $id .'"]';
$path = '//*[@id="'. $id .'"]';
$nodes = $this->rpt_xml->xpath($path);
$node = $nodes[0];
$dom=dom_import_simplexml($node);
......
FrxSyntaxEngine.inc
View file @ 0f4c7646
......@@ -7,7 +7,7 @@
* before substituting them.
*
*/
define('FRX_TOKEN_EXP', '/\{[^}]+}/');
define('FRX_TOKEN_EXP', '/\{[^\n^\r^}]+}/');
define('FRX_SQL_TOKEN', '/:([a-z]|[0-9]|{A-Z]|[-_])+/');
class FrxSyntaxEngine {
private $tpattern;
......@@ -92,4 +92,26 @@ class FrxSyntaxEngine {
}
return $text;
}
/**
* List all of the tokens used in a piece of text, ignoring duplicates.
*
* @param string $text
* @return array tokens contained in the text according to the regular expression.
*/
public function tokens($text) {
$match=array();
$tokens = array();
if (preg_match_all($this->tpattern, $text, $match)) {
$i=0;
foreach ($match[0] as $match_num => $token) {
$path = trim($token, $this->trim_chars);
if (array_search($path,$tokens)===FALSE) {
$tokens[] = $path;
}
}
}
return $tokens;
}
}
forena.admin.inc
View file @ 0f4c7646
This diff is collapsed.
forena.common.inc
View file @ 0f4c7646
......@@ -7,7 +7,7 @@
*/
// Include Report renderer.
require_once('FrxReport.inc');
require_once('FrxDataEngine.inc');
require_once('FrxDataProvider.inc');
/**
* Get name from argument 1 or alterntaively from a file name
......@@ -17,7 +17,7 @@ require_once('FrxDataEngine.inc');
function forena_report_desc($name='') {
if (!$name) $name = arg(1);
// Get defined document types
$doctypes = forena_supported_doctypes();
$doctypes = forena_supported_doctypes();
$parts = explode('.', $name);
$name ='';
......@@ -121,7 +121,7 @@ function forena_report($name_in, $parms = array()) {
//put title on top of report
$title = $r->title;
if (!$missing_parms) {
if (!$missing_parms) {
$output .= $r->render($format);
$css_files = forena_report_css($desc, $form, $format);
}
......@@ -156,20 +156,20 @@ function forena_report($name_in, $parms = array()) {
$rpt_xml = $r->rpt_xml;
$nodes = $rpt_xml->xpath('//frx:docgen/frx:doc');
$div .= '<div class="doclinks">';
$default_doctypes = variable_get('forena_doc_formats', array());
$default_doctypes = variable_get('forena_doc_formats', array());
if (!$missing_parms) {
if (!$nodes) {
if (!$nodes) {
//show the default. All supported links
foreach ($default_doctypes as $value) if (is_object(forena_get_doctypes($value))) {
$div .= '<a class="doclinks" href="'. $name_in . '.'. $value .'?'. $q .'">'. strtoupper($value) .'</a>';
$div .= '<a class="doclinks" href="'. $name_in . '.'. $value .'?'. $q .'">'. strtoupper($value) .'</a>';
}
}
else {
else {
//There were nodes. show the prefered doc types
foreach ($nodes as $value) {
$type = (string)$value['type'];
$doctypes = forena_supported_doctypes();
foreach ($nodes as $value) {
$arr = $value->attributes();
$type = (string)$arr['type'];
if ($doctypes[$type]) {
if (is_object(forena_get_doctypes($type))) {
$div .= '<a class="doclinks" href="'. $name . '.'. $type .'?'. $q .'">'. strtoupper($type) .'</a>';
......@@ -177,8 +177,7 @@ function forena_report($name_in, $parms = array()) {
}
}
}
$div .= '</div>';
$div .= '</div>';
$output = $div . '<div class="forena-report">'. $output .'</div>';
}
$path = drupal_get_path('module', 'forena');
......@@ -186,6 +185,7 @@ function forena_report($name_in, $parms = array()) {
if ($css_files) foreach ($css_files as $css_file) {
drupal_add_css($css_file, 'module');
}
return $output;
}
}
......@@ -203,26 +203,29 @@ function forena_report($name_in, $parms = array()) {
function __forena_load_repository(&$repo) {
// First determine if the class file exisits
$path = $repo['path'];
$conf = array();
if (file_exists($path .'/settings.php')) {
// This should at minimum set
// Override with repository specific data
include($path .'/settings.php');
}
$repo['user callback'] = $conf['user callback'];
$repo['data'] = __forena_load_engine($conf, $repo['path']);
$repo = array_merge($repo, $conf);
// $repo['user callback'] = $conf['user callback'];
$repo['data'] = __forena_load_provider($repo, $repo['path']);
//$repo['auth'] = __forena_load_auth($security_provider);
}
/**
* Load the data engine class based on the class name.
* Load the data provider class based on the class name.
*
* @param string $name
* @return object The data engine object
* @return object The data provider object
*/
function __forena_load_engine($conf, $repo_path) {
$name = $conf['data_engine'];
function __forena_load_provider($conf, $repo_path) {
$name = $conf['data provider'];
if (!$name) $name = $conf['data_engine'];
forena_define_plugins();
// Instantiate the path
if (class_exists($name)) {
......@@ -250,13 +253,13 @@ function forena_repository($name='') {
if ($_forena_repositories) {
$repos = $_forena_repositories;
}
// Overide difinitions of the sample and drupal repositories.
$repos['forena_help'] = array('path' => $path .'/repos/forena_help',
'title' => 'Forena Sample Reports');
$repos['drupal'] = array('path' => $path .'/repos/drupal',
'title' => 'Drupal Reports');
'title' => 'Drupal Reports');
}
// Now determine if the object exists
......@@ -301,19 +304,19 @@ function forena_load_cache($r_xhtml) {
if ($repos) foreach ($repos as $provider => $blocks) {
$repos = forena_repository($provider);
$engine = $repos['data'];
$conf = $engine->conf;
$provider = $repos['data'];
$conf = $provider->conf;
$access = array();
foreach ($blocks as $block_name) {
if ($engine && $block_name) {
if (method_exists($engine, 'load_block')) {
$conf = $engine->conf;
$block = $engine->load_block($block_name);
if ($provider && $block_name) {
if (method_exists($provider, 'load_block')) {
$conf = $provider->conf;
$block = $provider->load_block($block_name);
if (array_search($block['access'], $access)===FALSE) $access[]=$block['access'];
}
}
else {
//drupal_set_message('no engine found', 'error');
//drupal_set_message('no provider found', 'error');
}
}
if ($conf['access callback'] && $access) $cache['access'][$conf['access callback']]=$access;
......@@ -330,7 +333,7 @@ function forena_load_cache($r_xhtml) {
* @param string $clause order / where cause
* @return unknown
*/
function forena_invoke_data_engine($data_block, $parameters=array(), $clause='') {
function forena_invoke_data_provider($data_block, $parameters=array(), $clause='') {
list($provider, $block) = explode('/', $data_block, 2);
// Get the data
$repos = forena_repository($provider);
......@@ -340,16 +343,27 @@ function forena_invoke_data_engine($data_block, $parameters=array(), $clause='')
}
if ($repos['data']) {
$engine = $repos['data'];
$provider = $repos['data'];
$access = TRUE;
if (method_exists($engine, 'data')) {
if (method_exists($provider, 'data')) {
$xml = $engine->data($block, $parameters, $clause);
$xml = $provider->data($block, $parameters, $clause);
}
//drupal_set_message("xml invoked: ". htmlspecialchars($xml->asXML()));
return $xml;
}
}
/**
* Load information about a data block
*
* @param string $data_block provider/blockpath to use for the load.
* @return unknown
*/
/**
* Returns an array of information about the data block
* @param $data_block
* @return unknown_type
*/
function forena_load_block($data_block) {
list($provider, $block) = explode('/', $data_block, 2);
// Get the data
......@@ -357,16 +371,15 @@ function forena_load_block($data_block) {
$repos = forena_repository($provider);
if ($repos['data']) {
$engine = $repos['data'];
if (method_exists($engine, 'data')) {
$block_info = $engine->load_block($block);
$provider = $repos['data'];
if (method_exists($provider, 'load_block')) {
$block_info = $provider->load_block($block);
}
return $block_info;
}
}
/**
* Load the formatters for all initialized repositories.
*
......@@ -376,25 +389,25 @@ function forena_get_formatter($fkey) {
$repos = forena_repository();
foreach ($repos as $k => $r) {
$engine = $r['data'];
if ($engine && method_exists($engine, 'formats')) {
$f = $engine->formats();
if ($f[$fkey] && method_exists($engine, $fkey)) {
$provider = $r['data'];
if ($provider && method_exists($provider, 'formats')) {
$f = $provider->formats();
if ($f[$fkey] && method_exists($provider, $fkey)) {
// We found an object with the advertised method return it
return $engine;
return $provider;
}
}
}
//Did not find the formater in the data engine
//Did not find the formater in the data provider
//Look to see if it's in a control class
$controls = forena_define_controls();
foreach ($controls as $k => $r) {
$engine = $r;
if ($engine && method_exists($engine, 'formats')) {
$f = $engine->formats();
if ($f[$fkey] && method_exists($engine, $fkey)) {
$provider = $r;
if ($provider && method_exists($provider, 'formats')) {
$f = $provider->formats();
if ($f[$fkey] && method_exists($provider, $fkey)) {
// We found an object with the advertised method return it
return $engine;
return $provider;
}
}
}
......@@ -450,13 +463,10 @@ function forena_report_object($report='', $data='') {
* @param string $tag
* @return string
*/
function forena_inner_xml($xml,$tag) {
if (is_object($xml) && is_object($xml->$tag))
{
function forena_inner_xml($xml, $tag) {
if (is_object($xml) && is_object($xml->$tag)) {
$xml_data = $xml->$tag->asXML();
$xml_data = preg_replace("/<\/?" . $tag . "(.|\s)*?>/","",$xml_data);
//$xml_data = str_replace(array('<'.$tag.'>','</'.$tag.'>','<'.$tag.'/>'),array('','',''),$xml_data);
$xml_data = preg_replace("/<\/?" . $tag . "(.|\s)*?>/", "", $xml_data);
};
return $xml_data;
}
......@@ -495,9 +505,9 @@ function forena_format_data($value, $format, $format_str) {
* @param unknown_type $comment
*/
function forena_load_block_file($filepath, $comment='--', $trim) {
if (!file_exists($filepath)) {
return array();
}
if (!file_exists($filepath)) {
return array();
}
$block_data = file_get_contents($filepath);
$lines = explode("\n", $block_data);
......@@ -691,12 +701,12 @@ function forena_parameters_form_submit($form, &$form_state) {
function forena_get_doctypes($fkey) {
$controls = forena_define_controls();
foreach ($controls as $k => $r) {
$engine = $r;
if ($engine && method_exists($engine, 'doc_types')) {
$f = $engine->doc_types();
if ($f[$fkey] && method_exists($engine, $f[$fkey])) {
$provider = $r;
if ($provider && method_exists($provider, 'doc_types')) {
$f = $provider->doc_types();
if ($f[$fkey] && method_exists($provider, $f[$fkey])) {
// We found an object with the advertised method return it
return $engine;
return $provider;
}
}
}
......@@ -712,9 +722,9 @@ function forena_supported_doctypes() {
$controls = forena_define_controls();
$supported_doctypes = array();
foreach ($controls as $k => $r) {
$engine = $r;
if ($engine && method_exists($engine, 'doc_types')) {
$f = $engine->doc_types();
$provider = $r;
if ($provider && method_exists($provider, 'doc_types')) {
$f = $provider->doc_types();
$supported_doctypes = array_merge($supported_doctypes, $f);
}
}
......@@ -732,12 +742,12 @@ function forena_supported_doctypes() {
function forena_get_templates($fkey) {
$controls = forena_define_controls();
foreach ($controls as $k => $r) {
$engine = $r;
if ($engine && method_exists($engine, 'templates')) {
$f = $engine->templates();
if ($f[$fkey] && method_exists($engine, $fkey)) {
// We found an object with the advertised method return it
return $engine;
$provider = $r;
if ($provider && method_exists($provider, 'templates')) {
$f = $provider->templates();
if ($f[$fkey] && method_exists($provider, $fkey)) {
// We found an object with the advertised method, return it
return $provider;
}
}
}
......@@ -753,15 +763,28 @@ function forena_supported_templates() {
$controls = forena_define_controls();
$supported_templates = array();
foreach ($controls as $k => $r) {
$engine = $r;
if ($engine && method_exists($engine, 'templates')) {
$f = $engine->templates();
$provider = $r;
if ($provider && method_exists($provider, 'templates')) {
$f = $provider->templates();
$supported_templates = array_merge($supported_templates, $f);
}
}
return $supported_templates;
}
function forena_supported_formats() {
$controls = forena_define_controls();
$supported_formats = array();
$f = array();
foreach ($controls as $k => $r) {
$provider = $r;
if ($provider && method_exists($provider, 'formats')) {
$f = $provider->formats();
$supported_formats = array_merge($supported_formats, $f);
}
}
return $supported_formats;
}
/**
*
......
forena.module
View file @ 0f4c7646
......@@ -49,24 +49,43 @@ function forena_menu() {
'access arguments' => array('design any report'),
);
$items['reports/%/edit'] = array(
$items['reports/%/layout'] = array(
'title' => 'Layout',
'page callback' => 'forena_edit_report',
'page callback' => 'forena_layout_report',
'page arguments' => array(1),
'access arguments' => array('design any report'),
'description' => t('Edit the content of your node'),
'description' => t('Edit the layout of your report'),
'type' => MENU_LOCAL_TASK,
'file' => 'forena.common.inc',
);
$items['reports/%/add'] = array(
$items['reports/%/data'] = array(
'title' => 'Data',
'page callback' => 'forena_add_block',
'page callback' => 'forena_data_block',
'access arguments' => array('design any report'),
'description' => t('Add a data block to your report'),
'type' => MENU_LOCAL_TASK,
);
$items['reports/%/fields'] = array(
'title' => 'Fields',
'page callback' => 'forena_fields_report',
'page arguments' => array(1),
'access arguments' => array('design any report'),
'description' => t('Edit the fields of your report'),
'type' => MENU_LOCAL_TASK,
);
$items['reports/add'] = array(
'title' => t('Add Report'),
'page callback' => 'forena_add_report',
'page arguments' => array(1),
'access arguments' => array('create any report'),
'description' => t('Create a new report'),
'type' => MENU_NORMAL_ITEM,
);
$items['forena'] = array(
'page callback' => 'forena_user_reports',
'page arguments' => array(),
......@@ -76,28 +95,84 @@ function forena_menu() {
'file' => 'forena.common.inc',
);
$items['reports/%/fields'] = array(
'title' => 'Fields',
'page callback' => 'forena_fields_report',
'page arguments' => array(1),
'access arguments' => array('design any report'),
'description' => t('Edit the fields of your report'),
'type' => MENU_LOCAL_TASK,
$items['forena/fields/format/autocomplete'] = array(
'page callback' => 'forena_fields_format_autocomplete',
'access callback' => TRUE,
'type' => MENU_CALLBACK,
);
$items['forena/data_block/autocomplete'] = array(
'page callback' => 'forena_data_block_autocomplete',
'access callback' => TRUE,
'type' => MENU_CALLBACK,
);
return $items;
}
/**
* Auto complete for data blocks
* @param $string
* @return unknown_type
*/
function forena_data_block_autocomplete($string='') {
require_once('forena.admin.inc');
$data_blocks = forena_user_data_blocks($string);
if ($data_blocks) {
$temp = array_values($data_blocks);
$data_blocks = array_combine($temp, $temp);
}
else {
$data_blocks = array();
}
print drupal_json($data_blocks);
}
/**
* Auto complete for formats
* @param $string
* @return unknown_type
*/
function forena_fields_format_autocomplete($string='') {
require_once('forena.common.inc');
$matches = array();
$formats = forena_supported_formats();
if ($formats && $string) foreach ($formats as $name => $value) {
if (strpos(strtolower($name), strtolower($string)) !== FALSE || strpos(strtolower($value), strtolower($string))!==FALSE) {
$matches[$name] = $value;
}
}
print drupal_json($matches);
}
/**
* Calls forena_edit_form
* in forena.admin.inc
*/
function forena_edit_report() {
function forena_layout_report() {
require_once('forena.admin.inc');
return drupal_get_form('forena_layout_form');
}