<?php
/*

 * If there is the same file in config folder (/conf/plaincas.settings.php) it will be used instead of this, so either delete it there or move this file to config.
 * last update by https://galaxy.esn.org/users/petrzoufaly on 16.8.2015
 * this configuration should work on both local and national level without any changes (just change country code)
 * generates SectionCode.role groups, CZ_local, CZ_national and roles as well.. to see what it exactly does set our username as admin in config and check your username at DokuWiki Usermanagement page
 * caches section list from galaxy into local file for 1 week
 * 
 * my own roles are for example: user, CZ_local, CZ_national, CZ_national.regularBoardMember, CZ_national.webmaster, CZ_local.regularBoardMember, CZ_local.webmaster, CZ-USTI-ESN, CZ-USTI-ESN.regularBoardMember, CZ-USTI-ESN.webmaster
 * roles not listed below are not recognized and not transformed into dokuwiki groups (ie international IT committee member role) - as we dont need it on local and national level 
 *
 * The function plaincas_group_patterns has to return an array
 * with the groups as keys and the corresponding regular expressions as values.
 * Other groups can be assigned with the custom groups. 
 */
function plaincas_group_patterns() {
  //roles definitions
  $country = "CZ"; //upper case please
  $casGroups = array();
  $national_roles = array ('ALCoordinator','alumnus','nationalRepresentative','nationalViceRepresentative','pr','president','regularBoardMember','secretary','socialerasmus','treasurer','vicePresident','webmaster','projectCoordinator');
  $local_roles = array ('activeMember','activity','alumnus','cardManager','internationalStudent','localRepresentative','pr','president','regularBoardMember','secretary','socialerasmus','treasurer','vicePresident','webmaster');
  
  /* Manually added whole Slovak national board as they are our friends and speak the same language - almost ;) */
  $casGroups['SK_national'] = '/^(SK-[A-Z]{4}-[A-Z]{3}_National\.[^"]+)$/'; //anyone (not by list)
  
  /*************************/
  
  /*
  //national board roles, in case we need them.. or you can just use CZ_national.regularBoardMember
  $national_board_roles = array('nationalRepresentative','nationalViceRepresentative','president','regularBoardMember','secretary','treasurer','vicePresident','webmaster');
  $casGroups[$country.'_national_board'] = '/^('.$country.'-[A-Z]{4}-[A-Z]{3}_National\.(' . $national_board_roles . '))$/';
  */
  
  //whole groups (CZ_local, CZ_national)
  //old way: //$casGroups['cz_local'] = '/^('.$country.'-[A-Z]{4}-[A-Z]{3}_Local\.(' . implode("|", $local_roles) . '))$/'; //using just the role list
  $casGroups[$country.'_local'] = '/^('.$country.'-[A-Z]{4}-[A-Z]{3}_Local\.[^"]+)$/'; //anyone (not by role list)
  //old way: //$casGroups['cz_national'] = '/^('.$country.'-[A-Z]{4}-[A-Z]{3}_National\.(' . implode("|", $national_roles) . '))$/'; //using just the role list
  $casGroups[$country.'_national'] = '/^('.$country.'-[A-Z]{4}-[A-Z]{3}_National\.[^"]+)$/'; //anyone (not by list)
  
  //single roles in groups (CZ_local.all_roles_from_list, CZ_national.all_roles_from_list)
  foreach ($national_roles as $role) {
    $casGroups[$country.'_national.'.$role] = '/^('.$country.'-[A-Z]{4}-[A-Z]{3}_National\.'.$role.')$/';
  }
  foreach ($local_roles as $role) {
    $casGroups[$country.'_local.'.$role] = '/^('.$country.'-[A-Z]{4}-[A-Z]{3}_Local\.'.$role.')$/';
  }

  
  //==== dynamic section loading ===============================================
  $sections = array();
  
  //cache xml feed with sections from galaxy for 1 week, writes sections.xml into root
  $url = 'http://galaxy.esn.org/sections/xml';
  $xmlFeed = 'sections.xml';
  $ageInSeconds = 604800; // one week cache time
  if(!file_exists($xmlFeed) || filemtime($xmlFeed) < time() - $ageInSeconds) {
    $contents = file_get_contents($url);
    file_put_contents($xmlFeed, $contents);
  }
  
  
  $sxml = simplexml_load_file($xmlFeed);
  foreach($sxml->section as $section){
    if (strpos($section->sc,$country.'-') === 0) {
      //== whole sections ===========================
      //eg. CZ-USTI-ESN, CZ-LIBE-ESN, ...
      $casGroups[(string)$section->sc] = '/^('.$section->sc.'_Local\.[^"]+)$/';
      
      //== Local roles =========================
      //single local roles generation like CZ-USTI-ESN.president, CZ-USTI-ESN.alumnus,...
      foreach ($local_roles as $role) {
        $casGroups[$section->sc.'.'.$role] = '/^('.$section->sc.'_Local\.'.$role.')$/';
        }
      }
  }
  //==== dynamic section loading END ===========================================
  /*
  //==== manual section names ==================================================
  $sections = array(
      // group name used by dokuwiki => name in galaxy
      'CZ-ZLIN-ESN',
      'CZ-CBUD-VST',
      'CZ-PRAG-ICT',
      'CZ-OSTR-VSB',
      'CZ-HRKR-ESN',
      'CZ-LIBE-ESN',
      'CZ-PILS-UWB',
      'CZ-OLOM-UPA',
      'CZ-PRAG-VSE',
      'CZ-PRAG-CUN',
      'CZ-PRAG-CTU',
      'CZ-BRNO-ISC',
      'CZ-MZLU-ESN',
      'CZ-OSTR-ISC',
      'CZ-BRNO-VUT',
      'CZ-USTI-ESN'
    );
    
  foreach ($sections as $section) {
     
      //== whole sections ===========================
      //eg. ESN_Usti, ISC_VUT_Brno, ...
      $casGroups[$section] = '/^('.$section.'_Local\.[^"]+)$/'; //anyone (not by role list)
      //$casGroups[$key] = '/^('.$value.'_Local\.(' . implode("|", $local_roles) . '))$/'; //using just the list
      
      //== Local roles =========================
      //single local roles generation like ESN_Usti.president, ESN_Usti.alumnus,...
      foreach ($local_roles as $role) {
        $casGroups[$section.'.'.$role] = '/^('.$section.'_Local\.'.$role.')$/';
      }      
  }
  //==== manual section names END ==============================================
 */
 
 
  return $casGroups;
}

/*
 * The function plaincas_pattern_attributes has to return an array
 * with the CAS attributes which will be matched against the regular expressions
 * $attributes = phpCAS::getAttributes();
 */
function plaincas_pattern_attributes( $attributes ){
  $matchAttributes = array();

  // in this example the attribute 'roles' is an array
  // and all of the elements will be prepended by the attribute 'sc'
  $roles = $attributes['roles'];
  $section = $attributes['sc'];
  if (!is_array($roles)) {
    $roles = array($roles);
  }
  foreach ($roles as $role) {
    $matchAttributes[] = $section . '_' . $role;
  }

  // finally the array is returned.
  return $matchAttributes;
}

/*
 * The function plaincas_user_attributes has to return an array
 * with keys 'name' and 'mail' representing the user.
 * $attributes = phpCAS::getAttributes();
 */
function plaincas_user_attributes( $attributes ){
  return array(
    'name' => $attributes['first'] . ' ' . $attributes['last'], 
    'mail' => $attributes['mail'],
  );
}

/*
 * The function plaincas_custom_groups has to return an array
 * with groupnames as keys and an array or usernames.
 * 
 * Custom groups are independent of CAS attributes or groups but the group names can be the same.
 */
 /*
function plaincas_custom_groups(){
  
  $customGroups = array(
    'group1' => array('admin', 'userame2'),
    'group2' => array('username3', 'userame4'),
  );

  return $customGroups;
}

*/