ensureGeoExtraField() - Code Metrics - Inspection of "Merge pull request #6633 from christianbeeznest/of..." - chamilo/chamilo-lms - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 17aabf...36c7b4 )

unknown
created 2025-08-27 12:12 UTC
ensureGeoExtraField() A

↳ Parent: Project
Complexity

Conditions	4
Paths	4
Size

Total Lines	20
Code Lines	15
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	1
Metric	Value
cc	4
eloc	15
c	1
b	0
f	1
nc	4
nop	3
dl	0
loc	20
rs	9.7666
<?php
/* For licensing terms, see /license.txt */

/**
 * Social map with user geolocation (PluginHelper + Repository-based, APCu-safe)
 * - Validates plugin enabled for current access URL
 * - Reads config from access_url_rel_plugin.configuration
 * - Auto-creates missing extra fields (admin only)
 * - Supports JSON {"lat","lng"} and legacy "label::lat,lng" or "lat,lng"
 * - LEFT JOIN: shows markers if user filled at least one field
 * - Cache: APCu if available, otherwise FilesystemAdapter
 */

use Chamilo\CoreBundle\Framework\Container;
use Chamilo\CoreBundle\Helpers\AccessUrlHelper;
use Chamilo\CoreBundle\Helpers\PluginHelper;
use Chamilo\CoreBundle\Repository\AccessUrlRelPluginRepository;
use Symfony\Component\Cache\Adapter\ApcuAdapter;
use Symfony\Component\Cache\Adapter\FilesystemAdapter;

$cidReset = true;
require_once __DIR__.'/../inc/global.inc.php';

api_block_anonymous_users();

/* --------------------------------------------------
 * Helpers
 * -------------------------------------------------- */
function extractLatLng($raw) {
    if (empty($raw)) return [null, null];
    $raw = trim($raw);

    // JSON {"lat":...,"lng":...}
    if (strlen($raw) > 1 && $raw[0] === '{') {
        $obj = json_decode($raw, true);
        if (json_last_error() === JSON_ERROR_NONE && isset($obj['lat'], $obj['lng'])) {
            return [$obj['lat'], $obj['lng']];
        }
    }
    // Legacy "label::lat,lng"
    if (strpos($raw, '::') !== false) {
        [, $coords] = explode('::', $raw, 2);
        $p = array_map('trim', explode(',', $coords, 2));
        if (count($p) === 2) return [$p[0], $p[1]];
    }
    // Simple "lat,lng"
    if (strpos($raw, ',') !== false) {
        $p = array_map('trim', explode(',', $raw, 2));
        if (count($p) === 2) return [$p[0], $p[1]];
    }
    return [null, null];
}

function resolveGeoType(): int {
    if (defined('ExtraField::FIELD_TYPE_GEOLOCALIZATION')) return constant('ExtraField::FIELD_TYPE_GEOLOCALIZATION');
    if (defined('ExtraField::FIELD_TYPE_GEOLOCATION'))   return constant('ExtraField::FIELD_TYPE_GEOLOCATION');
    if (defined('ExtraField::FIELD_TYPE_TEXT'))          return constant('ExtraField::FIELD_TYPE_TEXT');
    return 1; // fallback (TEXT)
}

function ensureGeoExtraField(ExtraField $ef, ?string $var, string $label): ?array {
    if (empty($var)) return null;
    $info = $ef->get_handler_field_info_by_field_variable($var);
    if (!empty($info)) return $info;


    // Create the field only for platform admins
    if (api_is_platform_admin()) {
        $payload = [
            'variable'           => $var,
            'display_text'       => $label,
            'value_type'         => resolveGeoType(),
            'visible_to_self'    => 1,
            'visible_to_others'  => 1,
            'changeable'         => 1,
            'created_at'         => date('Y-m-d H:i:s'),
        ];
        $ef->save($payload);
        return $ef->get_handler_field_info_by_field_variable($var);

    }
    return null;
}

/* --------------------------------------------------
 * 1) Load helpers (PluginHelper, AccessUrlHelper, Repository)
 * -------------------------------------------------- */
$pluginHelper    = Container::$container
    ->get(PluginHelper::class);
$accessUrlHelper = Container::$container
    ->get(AccessUrlHelper::class);
$pluginRepo      = Container::$container
    ->get(AccessUrlRelPluginRepository::class);

$PLUGIN_NAME = 'google_maps';

/* Check plugin is enabled for the current access URL */
if (!$pluginHelper->isPluginEnabled($PLUGIN_NAME)) {
    if (api_is_platform_admin()) {
        Display::display_header(get_lang('Social'));
        echo Display::return_message(
            'Google Maps plugin is not enabled for this portal URL. Go to Administration → Plugins and enable it.',
            'warning'
        );
        echo '<p><a href="'.api_get_path(WEB_CODE_PATH).'admin/plugins.php">Open Plugins admin</a></p>';
        Display::display_footer();
        exit;
    }
    error_log('[social/map] DENY: plugin_disabled_in_url');
    api_not_allowed(true);
}

/* --------------------------------------------------
 * 2) Load plugin configuration from DB (by current URL)
 * -------------------------------------------------- */
$currentUrl = $accessUrlHelper->getCurrent();
if ($currentUrl === null) {
    error_log('[social/map] DENY: no current access URL');
    api_not_allowed(true);
}

$rel = $pluginRepo->findOneByPluginName($PLUGIN_NAME, $currentUrl->getId());
if (!$rel || !$rel->isActive()) {
    error_log('[social/map] DENY: plugin relation not active for url_id='.$currentUrl->getId());
    api_not_allowed(true);
}

$config = $rel->getConfiguration();
if (is_string($config)) {
    $decoded = json_decode($config, true);
    if (json_last_error() === JSON_ERROR_NONE) {
        $config = $decoded;
    }
}
if (!is_array($config)) $config = [];

$enabledRaw = $config['enable_api'] ?? null;
$apiKey     = (string) ($config['api_key'] ?? '');

/* Accept common truthy string/number values */
$localization = ($enabledRaw === true)
    || ($enabledRaw === 1)
    || ($enabledRaw === '1')
    || ($enabledRaw === 'true')
    || ($enabledRaw === 'on')
    || ($enabledRaw === 'yes');

if (!$localization || $apiKey === '') {
    if (api_is_platform_admin()) {
        Display::display_header(get_lang('Social'));
        echo Display::return_message(
            'Google Maps plugin is not configured. Enable the API and set your API key in Administration → Plugins → Google Maps.',
            'warning'
        );
        echo '<p><a href="'.api_get_path(WEB_CODE_PATH).'admin/plugins.php">Open Plugins admin</a></p>';
        Display::display_footer();
        exit;
    }
    error_log('[social/map] DENY: plugin_not_configured (enable_api='.var_export($enabledRaw,true).', api_key_present='.(int)($apiKey!=='').')');
    api_not_allowed(true);
}

/* --------------------------------------------------
 * 3) Fields to use (from plugin.extra_field_name or legacy setting)
 * -------------------------------------------------- */
$pluginFieldsCsv = (string) ($config['extra_field_name'] ?? '');
$vars = array_values(array_filter(array_map('trim', explode(',', $pluginFieldsCsv))));

if (empty($vars)) {
    $fieldsSetting = api_get_setting('profile.allow_social_map_fields', true);
    if (!$fieldsSetting || empty($fieldsSetting['fields']) || !is_array($fieldsSetting['fields'])) {
        error_log('[social/map] DENY: no fields configured (plugin.extra_field_name empty, allow_social_map_fields empty)');
        api_not_allowed(true);
    }
    $vars = array_values($fieldsSetting['fields']);
}

/* Keep at most 2 distinct variables */
$vars = array_values(array_unique(array_filter($vars)));
$var1 = $vars[0] ?? null; // e.g. terms_villedustage
$var2 = $vars[1] ?? null; // e.g. terms_ville

/* --------------------------------------------------
 * 4) Ensure extra fields exist (admin can auto-create), then continue if at least one is present
 * -------------------------------------------------- */
$extraField = new ExtraField('user');
$info1 = ensureGeoExtraField($extraField, $var1, $var1 ?: 'Geolocation A');
$info2 = ensureGeoExtraField($extraField, $var2, $var2 ?: 'Geolocation B');

if (empty($info1) && empty($info2)) {
    error_log('[social/map] DENY: missing both extrafields and cannot create (vars='.json_encode($vars).')');
    api_not_allowed(true);
}

/* --------------------------------------------------
 * 5) Query users (LEFT JOIN per existing field) - allow users with at least one value
 * -------------------------------------------------- */
$tableUser = Database::get_main_table(TABLE_MAIN_USER);

$select = "u.id, u.firstname, u.lastname";
$joins  = [];
$conds  = [];

if (!empty($info1)) {
    $select .= ", ev1.field_value AS f1";
    $joins[] = "LEFT JOIN extra_field_values ev1
                  ON ev1.item_id = u.id
                 AND ev1.field_id = ".$info1['id'];
    $conds[] = "COALESCE(ev1.field_value,'') <> ''";
}
if (!empty($info2)) {
    $select .= ", ev2.field_value AS f2";
    $joins[] = "LEFT JOIN extra_field_values ev2
                  ON ev2.item_id = u.id
                 AND ev2.field_id = ".$info2['id'];
    $conds[] = "COALESCE(ev2.field_value,'') <> ''";
}

if (empty($conds)) {
    error_log('[social/map] DENY: no join conditions built');
    api_not_allowed(true);
}

$sql = "SELECT $select
        FROM $tableUser u
        ".implode("\n", $joins)."
        WHERE u.active = 1
          AND u.status = ".STUDENT."
          AND (".implode(' OR ', $conds).")";

/* --------------------------------------------------
 * 6) Cache with fallback (APCu → Filesystem)
 * -------------------------------------------------- */
$useApcu = false;
if (function_exists('apcu_enabled')) {
    $useApcu = apcu_enabled();
} else {
    $useApcu = extension_loaded('apcu') && (PHP_SAPI !== 'cli' || (bool)ini_get('apc.enable_cli'));
}

if ($useApcu) {
    $cache = new ApcuAdapter('social_map');
} else {
    // Filesystem fallback
    $cacheDir = rtrim(sys_get_temp_dir(), DIRECTORY_SEPARATOR).DIRECTORY_SEPARATOR.'chamilo_cache';
    if (!is_dir($cacheDir)) {
        @mkdir($cacheDir, 0775, true);
        /** @scrutinizer ignore-unhandled */ @mkdir($cacheDir, 0775, true);
    }
    $cache = new FilesystemAdapter('social_map', 300, $cacheDir);
}

$keyDate = 'map_cache_date';
$keyData = 'map_cache_data';

$now     = time();
$expires = strtotime('+5 minute', $now);

/* Force refresh (keep same behavior as original code) */
$loadFromDatabase = true;

if ($loadFromDatabase) {
    $result = Database::query($sql);
    $data   = Database::store_result($result, 'ASSOC');

    $cacheItem = $cache->getItem($keyData);
    $cacheItem->set($data);
    $cache->save($cacheItem);

    $cacheItem = $cache->getItem($keyDate);
    $cacheItem->set($expires);
    $cache->save($cacheItem);
} else {
    $data = $cache->getItem($keyData)->get();
}

/* --------------------------------------------------
 * 7) Parse coordinates and prepare payload for the template
 * -------------------------------------------------- */
foreach ($data as &$row) {
    $row['complete_name'] = $row['firstname'].' '.$row['lastname'];
    $row['lastname']  = '';
    $row['firstname'] = '';

    if (array_key_exists('f1', $row)) {
        [$aLat, $aLng] = extractLatLng($row['f1']);
        if ($aLat !== null && $aLng !== null) {
            $row['f1_lat']  = $aLat;
            $row['f1_long'] = $aLng;
        }
        unset($row['f1']);
    }
    if (array_key_exists('f2', $row)) {
        [$bLat, $bLng] = extractLatLng($row['f2']);
        if ($bLat !== null && $bLng !== null) {
            $row['f2_lat']  = $bLat;
            $row['f2_long'] = $bLng;
        }
        unset($row['f2']);
    }
}

/* --------------------------------------------------
 * 8) Assets + render
 * -------------------------------------------------- */
$htmlHeadXtra[] = '<script type="text/javascript" src="'.api_get_path(WEB_LIBRARY_JS_PATH).'map/markerclusterer.js"></script>';
$htmlHeadXtra[] = '<script type="text/javascript" src="'.api_get_path(WEB_LIBRARY_JS_PATH).'map/oms.min.js"></script>';

$tpl = new Template(null);
$tpl->assign('url', api_get_path(WEB_PATH).'social');
$tpl->assign('places', json_encode($data));
$tpl->assign('api_key', $apiKey);       // typical variable name used by templates
$tpl->assign('gmap_api_key', $apiKey);  // also assign the legacy name, just in case

/* Labels (avoid notices if only one field exists) */
$tpl->assign('field_1', !empty($info1) ? ($info1['display_text'] ?? $var1 ?? '') : '');
$tpl->assign('field_2', !empty($info2) ? ($info2['display_text'] ?? $var2 ?? '') : '');

/* Icons (if your template uses them) */
$tpl->assign(
    'image_city',
    Display::return_icon('red-dot.png', '', [], ICON_SIZE_SMALL, false, true)
);
$tpl->assign(
    'image_stage',
    Display::return_icon('blue-dot.png', '', [], ICON_SIZE_SMALL, false, true)
);

$layout = $tpl->get_template('social/map.tpl');
$tpl->display($layout);

chamilo / chamilo-lms

Push — master ( 17aabf...36c7b4 )

ensureGeoExtraField() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
