blackicedbear/FHC-Core
1
0
Fork 0
mirror of https://github.com/FH-Complete/FHC-Core.git synced 2026-06-10 08:39:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

- Added JSON post parameter check in controllers/components/SearchBar->search

Browse Source 
- Expanded search capabilities for organization units and employees
This commit is contained in:
Paolo
2022-06-27 16:22:40 +02:00
parent 47f7c03075
commit 2a298dc6d1
2 changed files with 103 additions and 72 deletions
Download Patch File Download Diff File Expand all files Collapse all files
application/controllers/components/SearchBar.php
+19 -15
View File
@@ -11,37 +11,41 @@ class SearchBar extends FHC_Controller
const TYPES_PARAM = 'types';
/**
*
* Object initialization
*/
public function __construct()
{
parent::__construct();
//
// Load the library SearchBarLib
$this->load->library('SearchBarLib');
}
//------------------------------------------------------------------------------------------------------------------
// Public methods
public function index()
{
$this->load->view('test');
}
/**
*
* Gets a JSON body via HTTP POST and provides the parameters
*/
public function search()
{
//$searchstr = $this->input->post(self::SEARCHSTR_PARAM);
//$types = $this->input->post(self::TYPES_PARAM);
$json = json_decode($this->input->raw_input_stream, true);
$searchstr = $json[self::SEARCHSTR_PARAM];
$types = $json[self::TYPES_PARAM];
$json = json_decode($this->input->raw_input_stream);
$this->outputJson($this->searchbarlib->search($searchstr, $types));
// Checks if the searchstr and the types parameters are in the POSTed JSON
if (isset($json->{self::SEARCHSTR_PARAM}) && isset($json->{self::TYPES_PARAM}))
{
// Convert to json the result from searchbarlib->search
$this->outputJson(
$this->searchbarlib->search(
$json->{self::SEARCHSTR_PARAM},
$json->{self::TYPES_PARAM}
)
);
}
else // otherwise return an error in JSON format
{
$this->outputJsonError(SearchBarLib::ERROR_WRONG_JSON);
}
}
}
application/libraries/SearchBarLib.php
+84 -57
View File
@@ -8,11 +8,12 @@ if (! defined('BASEPATH')) exit('No direct script access allowed');
class SearchBarLib
{
//
const ERROR_WRONG_SEARCHSTR = 'ERR001';
const ERROR_NO_TYPES = 'ERR002';
const ERROR_WRONG_TYPES = 'ERR003';
const ERROR_WRONG_JSON = 'ERR001';
const ERROR_WRONG_SEARCHSTR = 'ERR002';
const ERROR_NO_TYPES = 'ERR003';
const ERROR_WRONG_TYPES = 'ERR004';
//
// List of allowed types of search
const ALLOWED_TYPES = ['mitarbeiter', 'organisationunit', 'raum', 'person', 'student', 'prestudent', 'document', 'cms'];
private $_ci; // Code igniter instance
@@ -24,7 +25,7 @@ class SearchBarLib
{
$this->_ci =& get_instance(); // get code igniter instance
//
// It is loaded only to have the DB_Model available
$this->_ci->load->model('person/Benutzer_model', 'BenutzerModel');
}
@@ -32,71 +33,63 @@ class SearchBarLib
// Public methods
/**
*
* It performes the search of the given search string using the specified search types
*/
public function search($searchstr, $types)
{
//
// Checks if the given parameters are fine
$search = $this->_checkParameters($searchstr, $types);
//
// If the check was successful then perform the search
if (isSuccess($search)) $search = $this->_search($searchstr, $types);
return $search; //
return $search; // return the result
}
//------------------------------------------------------------------------------------------------------------------
// Private methods
/**
*
* Checks:
* - The given searchstr is a not empty string
* - The given types is a not empty array and contains allowed search types
*/
private function _checkParameters($searchstr, $types)
{
//
if (isEmptyString($searchstr))
{
return error(self::ERROR_WRONG_SEARCHSTR);
}
// If searchstr is empty
if (isEmptyString($searchstr)) return error(self::ERROR_WRONG_SEARCHSTR);
//
if (isEmptyArray($types))
{
return error(self::ERROR_NO_TYPES);
}
else
{
//
if (!isEmptyArray(array_diff($types, self::ALLOWED_TYPES)))
{
return error(self::ERROR_WRONG_TYPES);
}
}
// If types is not an array or it is empty
if (isEmptyArray($types)) return error(self::ERROR_NO_TYPES);
return success(); //
// If all the elements in types are allowed search types
if (!isEmptyArray(array_diff($types, self::ALLOWED_TYPES))) return error(self::ERROR_WRONG_TYPES);
return success(); // The check is fine!
}
/**
*
* Loops on types and perform the search of that type using searchstr
* Then it collects all the returned data into an array as property of an object
*/
private function _search($searchstr, $types)
{
$data = array(); //
// Object to be returned
$result = new stdClass();
$result->data = array();
//
// For each search type
foreach ($types as $type)
{
//
$data = array_merge($data, $this->{'_'.$type}($searchstr, $type));
// Perform the search and then add the result to data
$result->data = array_merge($result->data, $this->{'_'.$type}($searchstr, $type));
}
$result = new stdClass();
$result->data = $data;
return $result;
}
/**
*
* Search for employees
*/
private function _mitarbeiter($searchstr, $type)
{
@@ -105,26 +98,38 @@ class SearchBarLib
$employees = $dbModel->execReadOnlyQuery('
SELECT
\''.$type.'\' AS type,
b.uid,
p.person_id,
b.uid AS uid,
p.person_id AS person_id,
p.vorname || \' \' || p.nachname AS name,
b.uid AS email,
ARRAY_AGG(DISTINCT(org.bezeichnung)) AS organisationunit_name,
b.uid || \''.'@'.DOMAIN.'\' AS email,
m.telefonklappe AS phone
FROM public.tbl_mitarbeiter m
JOIN public.tbl_benutzer b ON(b.uid = m.mitarbeiter_uid)
JOIN public.tbl_person p USING(person_id)
WHERE m.mitarbeiter_uid ILIKE \'%'.$dbModel->escapeLike($searchstr).'%\'
JOIN (
SELECT o.bezeichnung, bf.uid
FROM public.tbl_benutzerfunktion bf
JOIN public.tbl_organisationseinheit o USING(oe_kurzbz)
WHERE (bf.datum_von IS NULL OR bf.datum_von <= NOW())
AND (bf.datum_bis IS NULL OR bf.datum_bis >= NOW())
GROUP BY o.bezeichnung, bf.uid
) org USING(uid)
WHERE b.uid ILIKE \'%'.$dbModel->escapeLike($searchstr).'%\'
OR p.vorname ILIKE \'%'.$dbModel->escapeLike($searchstr).'%\'
OR p.nachname ILIKE \'%'.$dbModel->escapeLike($searchstr).'%\'
GROUP BY type, b.uid, p.person_id, name, email, m.telefonklappe
');
//
// If something has been found then return it
if (hasData($employees)) return getData($employees);
//
// Otherwise return an empty array
return array();
}
/**
*
* Seach for organisation units
*/
private function _organisationunit($searchstr, $type)
{
@@ -133,23 +138,45 @@ class SearchBarLib
$ous = $dbModel->execReadOnlyQuery('
SELECT
\''.$type.'\' AS type,
o.oe_kurzbz,
o.oe_kurzbz AS oe_kurzbz,
o.bezeichnung AS name,
o.oe_parent_kurzbz AS parentoe_kurzbz,
o.oe_parent_kurzbz AS parentoe_name
oParent.oe_kurzbz AS parentoe_kurzbz,
oParent.bezeichnung AS parentoe_name,
ARRAY_AGG(DISTINCT(bfLeader.uid)) AS leader_uid,
ARRAY_AGG(DISTINCT(p.vorname || \' \' || p.nachname)) AS leader_name,
COUNT(bfCount.benutzerfunktion_id) AS number_of_people
FROM public.tbl_organisationseinheit o
WHERE o.oe_kurzbz ILIKE \'%'.$dbModel->escapeLike($searchstr).'%\'
LEFT JOIN public.tbl_organisationseinheit oParent ON(oParent.oe_kurzbz = o.oe_parent_kurzbz)
LEFT JOIN (
SELECT benutzerfunktion_id, oe_kurzbz, uid
FROM public.tbl_benutzerfunktion
WHERE (datum_von IS NULL OR datum_von <= NOW())
AND (datum_bis IS NULL OR datum_bis >= NOW())
) bfCount ON(bfCount.oe_kurzbz = o.oe_kurzbz)
LEFT JOIN (
SELECT oe_kurzbz, uid
FROM public.tbl_benutzerfunktion
WHERE funktion_kurzbz = \'Leitung\'
AND (datum_von IS NULL OR datum_von <= NOW())
AND (datum_bis IS NULL OR datum_bis >= NOW())
) bfLeader ON(bfLeader.oe_kurzbz = o.oe_kurzbz)
LEFT JOIN public.tbl_benutzer b ON(b.uid = bfLeader.uid)
LEFT JOIN public.tbl_person p USING(person_id)
WHERE b.aktiv = TRUE
AND o.oe_kurzbz ILIKE \'%'.$dbModel->escapeLike($searchstr).'%\'
OR o.bezeichnung ILIKE \'%'.$dbModel->escapeLike($searchstr).'%\'
GROUP BY type, o.oe_kurzbz, o.bezeichnung, oParent.oe_kurzbz, oParent.bezeichnung
');
//
// If something has been found then return it
if (hasData($ous)) return getData($ous);
//
// Otherwise return an empty array
return array();
}
/**
*
* Search for persons
*/
private function _person($searchstr, $type)
{
@@ -157,7 +184,7 @@ class SearchBarLib
}
/**
*
* Search for students
*/
private function _student($searchstr, $type)
{
@@ -165,7 +192,7 @@ class SearchBarLib
}
/**
*
* Search for prestudents
*/
private function _prestudent($searchstr, $type)
{
@@ -173,7 +200,7 @@ class SearchBarLib
}
/**
*
* Search for documents
*/
private function _document($searchstr, $type)
{
@@ -181,7 +208,7 @@ class SearchBarLib
}
/**
*
* Search for CMSs
*/
private function _cms($searchstr, $type)
{
@@ -189,7 +216,7 @@ class SearchBarLib
}
/**
*
* Search for rooms
*/
private function _raum($searchstr, $type)
{