diff --git a/README.md b/README.md index 353ad64..0d19317 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,8 @@ # Wordpress multisite for YunoHost ================== -Site du project Yunohost : [Yunohost.org](https://yunohost.org/#/) +[Yunohost project](https://yunohost.org/#/) +https://wordpress.org/ ======= @@ -9,10 +10,6 @@ Site du project Yunohost : [Yunohost.org](https://yunohost.org/#/) Wordpress lets you create your blog or web site very easily.
With this package, you can even activate the [multisite](http://codex.wordpress.org/Glossary#Multisite) -https://wordpress.org/ - -If the multisite option is activated, the script also installs *php5-cli*. - **How to upgrade the package:** 1) sudo yunohost app upgrade --verbose wordpress -u https://github.com/YunoHost-Apps/wordpress_ynh
2) To be noted that once installed, the updates of the php code of the Wordpress blog are managed from the Wordpress web admin interface.
@@ -20,13 +17,15 @@ If the multisite option is activated, the script also installs *php5-cli*. **Multi-user support:** Yes, with LDAP ability. +**See the status of this package:** +*[Last weekly report](https://forum.yunohost.org/t/rapport-hebdomadaire-dintegration-continue/2297)* +*[Last continuous integration test](https://ci-apps.yunohost.org/jenkins/job/wordpress%20%28Official%29/lastBuild/consoleFull)* + +======= + ## Version Française Logiciel de création de blog ou de site Web avec option [multisite](http://codex.wordpress.org/Glossary#Multisite) -https://wordpress.org/ - -Si l'option multisite est activée, le script installe le paquet *php5-cli*. - **Mise à jour du package:** 1) sudo yunohost app upgrade --verbose wordpress -u https://github.com/YunoHost-Apps/wordpress_ynh
2) A noter qu'une fois installé, les mises à jour du code php du blog Wordpress se font depuis l'interface wed d'admin de Wordpress
diff --git a/check_process b/check_process index b6fdfcb..d67ff3a 100644 --- a/check_process +++ b/check_process @@ -1,5 +1,4 @@ ;; Test complet sans multisite - auto_remove=1 ; Manifest domain="domain.tld" (DOMAIN) path="/path" (PATH) @@ -21,7 +20,6 @@ port_already_use=0 change_url=0 ;; Test avec multisite - auto_remove=1 ; Manifest domain="domain.tld" (DOMAIN) path="/path" (PATH) diff --git a/conf/app.src b/conf/app.src index 278d60f..96acb1a 100644 --- a/conf/app.src +++ b/conf/app.src @@ -1,5 +1,5 @@ -SOURCE_URL=https://wordpress.org/wordpress-4.7.2.tar.gz -SOURCE_SUM=17f9fe2fa6d14eba86aad152059b5afd +SOURCE_URL=https://wordpress.org/wordpress-4.8.tar.gz +SOURCE_SUM=b91248a7220a7fb1ca293c3a0ec8db6c SOURCE_SUM_PRG=md5sum ARCH_FORMAT=tar.gz SOURCE_IN_SUBDIR=true diff --git a/conf/sql/common.sql b/conf/sql/common.sql index 96a720b..c56f29f 100644 --- a/conf/sql/common.sql +++ b/conf/sql/common.sql @@ -1,2 +1 @@ INSERT INTO wp_options VALUES('','http_authentication_options','a:8:{s:13:"allow_wp_auth";b:1;s:10:"auth_label";s:19:"HTTP authentication";s:9:"login_uri";s:40:"https://__DOMAIN_PATH__/wp-login.php";s:10:"logout_uri";s:28:"https://__DOMAIN_PATH__/";s:22:"additional_server_keys";s:13:"PHP_AUTH_USER";s:24:"auto_create_email_domain";s:0:"";s:10:"db_version";i:2;s:16:"auto_create_user";b:0;}','yes'); -INSERT INTO wp_options (option_id,option_name,option_value,autoload) VALUES('','WPLANG','__LANGUAGE__','yes') ON DUPLICATE KEY UPDATE option_value=VALUES(option_value); diff --git a/conf/sql/multisite.sql b/conf/sql/multisite.sql index c723a9d..892a229 100644 --- a/conf/sql/multisite.sql +++ b/conf/sql/multisite.sql @@ -1,3 +1 @@ INSERT INTO wp_sitemeta VALUES('',1,'sll_settings','a:14:{s:14:"account_suffix";s:0:"";s:7:"base_dn";s:27:"ou=users,dc=yunohost,dc=org";s:18:"domain_controllers";a:1:{i:0;s:9:"localhost";}s:9:"directory";s:2:"ol";s:4:"role";s:10:"subscriber";s:13:"high_security";s:5:"false";s:8:"ol_login";s:3:"uid";s:7:"use_tls";s:5:"false";s:9:"ldap_port";s:3:"389";s:12:"ldap_version";s:1:"3";s:12:"create_users";s:4:"true";s:7:"enabled";s:4:"true";s:7:"version";s:3:"1.5";s:6:"groups";a:1:{i:0;s:0:"";}}'); -#--PUBLIC--UPDATE wp_sitemeta SET meta_value='a:1:{s:39:"simple-ldap-login/Simple-LDAP-Login.php";i:__DATE__;}' WHERE meta_key='active_sitewide_plugins'; -#--PRIVATE--UPDATE wp_sitemeta SET meta_value='a:2:{s:39:"simple-ldap-login/Simple-LDAP-Login.php";i:__DATE__;s:43:"http-authentication/http-authentication.php";i:__DATE__;}' WHERE meta_key='active_sitewide_plugins'; diff --git a/conf/sql/single.sql b/conf/sql/single.sql index f7e92bf..0326ecc 100644 --- a/conf/sql/single.sql +++ b/conf/sql/single.sql @@ -1,3 +1 @@ INSERT INTO wp_options VALUES('','sll_settings','a:14:{s:14:"account_suffix";s:0:"";s:7:"base_dn";s:27:"ou=users,dc=yunohost,dc=org";s:18:"domain_controllers";a:1:{i:0;s:9:"localhost";}s:9:"directory";s:2:"ol";s:4:"role";s:10:"subscriber";s:13:"high_security";s:5:"false";s:8:"ol_login";s:3:"uid";s:7:"use_tls";s:5:"false";s:9:"ldap_port";s:3:"389";s:12:"ldap_version";s:1:"3";s:12:"create_users";s:4:"true";s:7:"enabled";s:4:"true";s:7:"version";s:3:"1.5";s:6:"groups";a:1:{i:0;s:0:"";}}','yes'); -#--PRIVATE--UPDATE wp_options SET option_value='a:2:{i:0;s:43:"http-authentication/http-authentication.php";i:1;s:39:"simple-ldap-login/Simple-LDAP-Login.php";}' WHERE option_name='active_plugins'; -#--PUBLIC--UPDATE wp_options SET option_value='a:1:{i:1;s:39:"simple-ldap-login/Simple-LDAP-Login.php";}' WHERE option_name='active_plugins'; diff --git a/conf/wp-config.php b/conf/wp-config.php index 099b59f..f53900b 100644 --- a/conf/wp-config.php +++ b/conf/wp-config.php @@ -1,14 +1,51 @@ = 2.4" - }, "description": { "en": "Create a beautiful blog or website easily", "fr": "Logiciel de création de blog ou de site Web" }, - "version": "4.7.2", + "version": "4.8", "url": "https://wordpress.org/", "license": "GPLv2", "maintainer": { "name": "Maniack Crudelis", "email": "maniackc_dev@crudelis.fr" }, + "requirements": { + "yunohost": ">= 2.7.2" + }, "multi_instance": true, "services": [ "nginx", @@ -58,8 +58,8 @@ "en": "Choose the language of the WordPress site", "fr": "Choissisez la langue du WordPress" }, - "choices": ["en_EN", "fr_FR"], - "default": "en_EN" + "choices": ["en_US", "fr_FR"], + "default": "en_US" }, { "name": "multisite", diff --git a/scripts/_common.sh b/scripts/_common.sh index 266a076..37c4432 100755 --- a/scripts/_common.sh +++ b/scripts/_common.sh @@ -1,147 +1,13 @@ #!/bin/bash -#================================================= -#================================================= -# TESTING -#================================================= -#================================================= - -ynh_fpm_config () { - finalphpconf="/etc/php5/fpm/pool.d/$app.conf" - ynh_backup_if_checksum_is_different "$finalphpconf" 1 - sudo cp ../conf/php-fpm.conf "$finalphpconf" - ynh_replace_string "__NAMETOCHANGE__" "$app" "$finalphpconf" - ynh_replace_string "__FINALPATH__" "$final_path" "$finalphpconf" - ynh_replace_string "__USER__" "$app" "$finalphpconf" - sudo chown root: "$finalphpconf" - ynh_store_file_checksum "$finalphpconf" - - if [ -e "../conf/php-fpm.ini" ] - then - finalphpini="/etc/php5/fpm/conf.d/20-$app.ini" - ynh_backup_if_checksum_is_different "$finalphpini" 1 - sudo cp ../conf/php-fpm.ini "$finalphpini" - sudo chown root: "$finalphpini" - ynh_store_file_checksum "$finalphpini" - fi - - sudo systemctl reload php5-fpm -} - -ynh_remove_fpm_config () { - ynh_secure_remove "/etc/php5/fpm/pool.d/$app.conf" - ynh_secure_remove "/etc/php5/fpm/conf.d/20-$app.ini" - sudo systemctl reload php5-fpm -} - -ynh_nginx_config () { - finalnginxconf="/etc/nginx/conf.d/$domain.d/$app.conf" - ynh_backup_if_checksum_is_different "$finalnginxconf" 1 - sudo cp ../conf/nginx.conf "$finalnginxconf" - - # To avoid a break by set -u, use a void substitution ${var:-}. If the variable is not set, it's simply set with an empty variable. - # Substitute in a nginx config file only if the variable is not empty - if test -n "${path_url:-}"; then - ynh_replace_string "__PATH__" "$path_url" "$finalnginxconf" - fi - if test -n "${domain:-}"; then - ynh_replace_string "__DOMAIN__" "$domain" "$finalnginxconf" - fi - if test -n "${port:-}"; then - ynh_replace_string "__PORT__" "$port" "$finalnginxconf" - fi - if test -n "${app:-}"; then - ynh_replace_string "__NAME__" "$app" "$finalnginxconf" - fi - if test -n "${final_path:-}"; then - ynh_replace_string "__FINALPATH__" "$final_path" "$finalnginxconf" - fi - ynh_store_file_checksum "$finalnginxconf" - - sudo systemctl reload nginx -} - -ynh_remove_nginx_config () { - ynh_secure_remove "/etc/nginx/conf.d/$domain.d/$app.conf" - sudo systemctl reload nginx -} - -ynh_systemd_config () { - finalsystemdconf="/etc/systemd/system/$app.service" - ynh_backup_if_checksum_is_different "$finalsystemdconf" 1 - sudo cp ../conf/systemd.service "$finalsystemdconf" - - # To avoid a break by set -u, use a void substitution ${var:-}. If the variable is not set, it's simply set with an empty variable. - # Substitute in a nginx config file only if the variable is not empty - if test -n "${final_path:-}"; then - ynh_replace_string "__FINALPATH__" "$final_path" "$finalsystemdconf" - fi - if test -n "${app:-}"; then - ynh_replace_string "__APP__" "$app" "$finalsystemdconf" - fi - ynh_store_file_checksum "$finalsystemdconf" - - sudo chown root: "$finalsystemdconf" - sudo systemctl enable $app - sudo systemctl daemon-reload -} - -ynh_remove_systemd_config () { - finalsystemdconf="/etc/systemd/system/$app.service" - if [ -e "$finalsystemdconf" ]; then - sudo systemctl stop $app - sudo systemctl disable $app - ynh_secure_remove "$finalsystemdconf" - fi -} - -#================================================= -#================================================= - -#================================================= -# CHECKING -#================================================= - -CHECK_DOMAINPATH () { # Vérifie la disponibilité du path et du domaine. - if sudo yunohost app --help | grep --quiet url-available - then - # Check availability of a web path - ynh_webpath_available $domain $path_url - # Register/book a web path for an app - ynh_webpath_register $app $domain $path_url - else - # Use the legacy command - sudo yunohost app checkurl $domain$path_url -a $app - fi -} - -CHECK_FINALPATH () { # Vérifie que le dossier de destination n'est pas déjà utilisé. - final_path=/var/www/$app - test ! -e "$final_path" || ynh_die "This path already contains a folder" -} - #================================================= # DISPLAYING #================================================= -NO_PRINT () { # Supprime l'affichage dans stdout pour la commande en argument. - set +x - $@ - set -x -} - WARNING () { # Écrit sur le canal d'erreur pour passer en warning. $@ >&2 } -SUPPRESS_WARNING () { # Force l'écriture sur la sortie standard - $@ 2>&1 -} - -QUIET () { # Redirige la sortie standard dans /dev/null - $@ > /dev/null -} - ALL_QUIET () { # Redirige la sortie standard et d'erreur dans /dev/null $@ > /dev/null 2>&1 } @@ -150,35 +16,6 @@ ALL_QUIET () { # Redirige la sortie standard et d'erreur dans /dev/null # BACKUP #================================================= -BACKUP_FAIL_UPGRADE () { - WARNING echo "Upgrade failed." - app_bck=${app//_/-} # Replace all '_' by '-' - if sudo yunohost backup list | grep -q $app_bck-pre-upgrade$backup_number; then # Vérifie l'existence de l'archive avant de supprimer l'application et de restaurer - sudo yunohost app remove $app # Supprime l'application avant de la restaurer. - sudo yunohost backup restore --ignore-hooks $app_bck-pre-upgrade$backup_number --apps $app --force # Restore the backup if upgrade failed - ynh_die "The app was restored to the way it was before the failed upgrade." - fi -} - -BACKUP_BEFORE_UPGRADE () { # Backup the current version of the app, restore it if the upgrade fails - backup_number=1 - old_backup_number=2 - app_bck=${app//_/-} # Replace all '_' by '-' - if sudo yunohost backup list | grep -q $app_bck-pre-upgrade1; then # Vérifie l'existence d'une archive déjà numéroté à 1. - backup_number=2 # Et passe le numéro de l'archive à 2 - old_backup_number=1 - fi - - sudo yunohost backup create --ignore-hooks --apps $app --name $app_bck-pre-upgrade$backup_number # Créer un backup différent de celui existant. - if [ "$?" -eq 0 ]; then # Si le backup est un succès, supprime l'archive précédente. - if sudo yunohost backup list | grep -q $app_bck-pre-upgrade$old_backup_number; then # Vérifie l'existence de l'ancienne archive avant de la supprimer, pour éviter une erreur. - QUIET sudo yunohost backup delete $app_bck-pre-upgrade$old_backup_number - fi - else # Si le backup a échoué - ynh_die "Backup failed, the upgrade process was aborted." - fi -} - HUMAN_SIZE () { # Transforme une taille en Ko en une taille lisible pour un humain human=$(numfmt --to=iec --from-unit=1K $1) echo $human @@ -186,8 +23,8 @@ HUMAN_SIZE () { # Transforme une taille en Ko en une taille lisible pour un huma CHECK_SIZE () { # Vérifie avant chaque backup que l'espace est suffisant file_to_analyse=$1 - backup_size=$(sudo du --summarize "$file_to_analyse" | cut -f1) - free_space=$(sudo df --output=avail "/home/yunohost.backup" | sed 1d) + backup_size=$(du --summarize "$file_to_analyse" | cut -f1) + free_space=$(df --output=avail "/home/yunohost.backup" | sed 1d) if [ $free_space -le $backup_size ] then @@ -196,655 +33,3 @@ CHECK_SIZE () { # Vérifie avant chaque backup que l'espace est suffisant ynh_die "Espace nécessaire: $(HUMAN_SIZE $backup_size)" fi } - -# Ce helper est temporaire et sert de remplacement à la véritable fonction ynh_restore_file. Le temps qu'elle arrive... -ynh_restore_file () { - if [ -f "$1" ]; then - ynh_die "There is already a file at this path: $1" - fi - sudo cp -a "${YNH_APP_BACKUP_DIR}$1" "$1" -} - -#================================================= -# PACKAGE CHECK BYPASSING... -#================================================= - -IS_PACKAGE_CHECK () { # Détermine une exécution en conteneur (Non testé) - return $(uname -n | grep -c 'pchecker_lxc') -} - -#================================================= -# NODEJS -#================================================= - -sudo_path () { - sudo env "PATH=$PATH" $@ -} - -# INFOS -# n (Node version management) utilise la variable PATH pour stocker le path de la version de node à utiliser. -# C'est ainsi qu'il change de version -# En attendant une généralisation de root, il est possible d'utiliser sudo avec le helper temporaire sudo_path -# Il permet d'utiliser sudo en gardant le $PATH modifié -# ynh_install_nodejs installe la version de nodejs demandée en argument, avec n -# ynh_use_nodejs active une version de nodejs dans le script courant -# 3 variables sont mises à disposition, et 2 sont stockées dans la config de l'app -# - nodejs_path: Le chemin absolu de cette version de node -# Utilisé pour des appels directs à node. -# - nodejs_version: Simplement le numéro de version de nodejs pour cette application -# - nodejs_use_version: Un alias pour charger une version de node dans le shell courant. -# Utilisé pour démarrer un service ou un script qui utilise node ou npm -# Dans ce cas, c'est $PATH qui contient le chemin de la version de node. Il doit être propagé sur les autres shell si nécessaire. - -n_install_dir="/opt/node_n" -ynh_use_nodejs () { - nodejs_version=$(ynh_app_setting_get $app nodejs_version) - - load_n_path="[[ :$PATH: == *\":$n_install_dir/bin:\"* ]] || PATH+=\":$n_install_dir/bin\"" - - nodejs_use_version="n $nodejs_version" - - # "Load" a version of node - eval $load_n_path; $nodejs_use_version - eval $load_n_path; sudo env "PATH=$PATH" $nodejs_use_version - - # Get the absolute path of this version of node - nodejs_path="$(n bin $nodejs_version)" - - # Make an alias for node use - ynh_node_exec="eval $load_n_path; n use $nodejs_version" - sudo_ynh_node_exec="eval $load_n_path; sudo env \"PATH=$PATH\" n use $nodejs_version" -} - -ynh_install_nodejs () { - # Use n, https://github.com/tj/n to manage the nodejs versions - local nodejs_version="$1" - local n_install_script="https://git.io/n-install" - - # Create $n_install_dir - sudo mkdir -p "$n_install_dir" - - # Load n path in PATH - PATH+=":$n_install_dir/bin" - - # If n is not previously setup, install it - n --version > /dev/null 2>&1 || \ - ( echo "Installation of N - Node.js version management" >&2; \ - curl -sL $n_install_script | sudo N_PREFIX="$n_install_dir" bash -s -- -y $nodejs_version ) - - # Install the requested version of nodejs (except for the first installation of n, which installed the requested version of node.) - sudo env "PATH=$PATH" n $nodejs_version - - # Use the real installed version. Sometimes slightly different - nodejs_version=$(node --version | cut -c2-) - - # Store the ID of this app and the version of node requested for it - echo "$YNH_APP_ID:$nodejs_version" | sudo tee --append "$n_install_dir/ynh_app_version" - - # Store nodejs_version into the config of this app - ynh_app_setting_set $app nodejs_version $nodejs_version - - ynh_use_nodejs -} - -ynh_remove_nodejs () { - ynh_use_nodejs - - # Remove the line for this app - sudo sed --in-place "/$YNH_APP_ID:$nodejs_version/d" "$n_install_dir/ynh_app_version" - - # If none another app uses this version of nodejs, remove it. - if ! grep --quiet "$nodejs_version" "$n_install_dir/ynh_app_version" - then - n rm $nodejs_version - fi - - # If none another app uses n, remove n - if [ ! -s "$n_install_dir/ynh_app_version" ] - then - ynh_secure_remove "$n_install_dir" - sudo sed --in-place "/N_PREFIX/d" /root/.bashrc - fi -} - -#================================================= -#================================================= -# FUTUR YNH HELPERS -#================================================= -# Importer ce fichier de fonction avant celui des helpers officiel -# Ainsi, les officiels prendront le pas sur ceux-ci le cas échéant -#================================================= - -# Normalize the url path syntax -# Handle the slash at the beginning of path and its absence at ending -# Return a normalized url path -# -# example: url_path=$(ynh_normalize_url_path $url_path) -# ynh_normalize_url_path example -> /example -# ynh_normalize_url_path /example -> /example -# ynh_normalize_url_path /example/ -> /example -# ynh_normalize_url_path / -> / -# -# usage: ynh_normalize_url_path path_to_normalize -# | arg: url_path_to_normalize - URL path to normalize before using it -ynh_normalize_url_path () { - path_url=$1 - test -n "$path_url" || ynh_die "ynh_normalize_url_path expect a URL path as first argument and received nothing." - if [ "${path_url:0:1}" != "/" ]; then # If the first character is not a / - path_url="/$path_url" # Add / at begin of path variable - fi - if [ "${path_url:${#path_url}-1}" == "/" ] && [ ${#path_url} -gt 1 ]; then # If the last character is a / and that not the only character. - path_url="${path_url:0:${#path_url}-1}" # Delete the last character - fi - echo $path_url -} - -# Check if a mysql user exists -# -# usage: ynh_mysql_user_exists user -# | arg: user - the user for which to check existence -function ynh_mysql_user_exists() -{ - local user=$1 - if [[ -z $(ynh_mysql_execute_as_root "SELECT User from mysql.user WHERE User = '$user';") ]] - then - return 1 - else - return 0 - fi -} - -# Create a database, an user and its password. Then store the password in the app's config -# -# After executing this helper, the password of the created database will be available in $db_pwd -# It will also be stored as "mysqlpwd" into the app settings. -# -# usage: ynh_mysql_setup_db user name [pwd] -# | arg: user - Owner of the database -# | arg: name - Name of the database -# | arg: pwd - Password of the database. If not given, a password will be generated -ynh_mysql_setup_db () { - local db_user="$1" - local db_name="$2" - local new_db_pwd=$(ynh_string_random) # Generate a random password - db_pwd="${3:-$new_db_pwd}" - ynh_mysql_create_db "$db_name" "$db_user" "$db_pwd" # Create the database - ynh_app_setting_set $app mysqlpwd $db_pwd # Store the password in the app's config -} - -# Remove a database if it exists, and the associated user -# -# usage: ynh_mysql_remove_db user name -# | arg: user - Owner of the database -# | arg: name - Name of the database -ynh_mysql_remove_db () { - local db_user="$1" - local db_name="$2" - local mysql_root_password=$(sudo cat $MYSQL_ROOT_PWD_FILE) - if mysqlshow -u root -p$mysql_root_password | grep -q "^| $db_name"; then # Check if the database exists - echo "Removing database $db_name" >&2 - ynh_mysql_drop_db $db_name # Remove the database - else - echo "Database $db_name not found" >&2 - fi - - # Remove mysql user if it exists - if $(ynh_mysql_user_exists $db_user); then - ynh_mysql_drop_user $db_user - fi -} - -# Correct the name given in argument for mariadb -# -# Avoid invalid name for your database -# -# Exemple: dbname=$(ynh_make_valid_dbid $app) -# -# usage: ynh_make_valid_dbid name -# | arg: name - name to correct -# | ret: the corrected name -ynh_sanitize_dbid () { - dbid=${1//[-.]/_} # We should avoid having - and . in the name of databases. They are replaced by _ - echo $dbid -} - -# Manage a fail of the script -# -# Print a warning to inform that the script was failed -# Execute the ynh_clean_setup function if used in the app script -# -# usage of ynh_clean_setup function -# This function provide a way to clean some residual of installation that not managed by remove script. -# To use it, simply add in your script: -# ynh_clean_setup () { -# instructions... -# } -# This function is optionnal. -# -# Usage: ynh_exit_properly is used only by the helper ynh_abort_if_errors. -# You must not use it directly. -ynh_exit_properly () { - exit_code=$? - if [ "$exit_code" -eq 0 ]; then - exit 0 # Exit without error if the script ended correctly - fi - - trap '' EXIT # Ignore new exit signals - set +eu # Do not exit anymore if a command fail or if a variable is empty - - echo -e "!!\n $app's script has encountered an error. Its execution was cancelled.\n!!" >&2 - - if type -t ynh_clean_setup > /dev/null; then # Check if the function exist in the app script. - ynh_clean_setup # Call the function to do specific cleaning for the app. - fi - - ynh_die # Exit with error status -} - -# Exit if an error occurs during the execution of the script. -# -# Stop immediatly the execution if an error occured or if a empty variable is used. -# The execution of the script is derivate to ynh_exit_properly function before exit. -# -# Usage: ynh_abort_if_errors -ynh_abort_if_errors () { - set -eu # Exit if a command fail, and if a variable is used unset. - trap ynh_exit_properly EXIT # Capturing exit signals on shell script -} - -# Define and install dependencies with a equivs control file -# This helper can/should only be called once per app -# -# usage: ynh_install_app_dependencies dep [dep [...]] -# | arg: dep - the package name to install in dependence -ynh_install_app_dependencies () { - dependencies=$@ - manifest_path="../manifest.json" - if [ ! -e "$manifest_path" ]; then - manifest_path="../settings/manifest.json" # Into the restore script, the manifest is not at the same place - fi - version=$(sudo grep '\"version\": ' "$manifest_path" | cut -d '"' -f 4) # Retrieve the version number in the manifest file. - dep_app=${app//_/-} # Replace all '_' by '-' - - if ynh_package_is_installed "${dep_app}-ynh-deps"; then - echo "A package named ${dep_app}-ynh-deps is already installed" >&2 - else - cat > ./${dep_app}-ynh-deps.control << EOF # Make a control file for equivs-build -Section: misc -Priority: optional -Package: ${dep_app}-ynh-deps -Version: ${version} -Depends: ${dependencies// /, } -Architecture: all -Description: Fake package for ${app} (YunoHost app) dependencies - This meta-package is only responsible of installing its dependencies. -EOF - ynh_package_install_from_equivs ./${dep_app}-ynh-deps.control \ - || ynh_die "Unable to install dependencies" # Install the fake package and its dependencies - ynh_app_setting_set $app apt_dependencies $dependencies - fi -} - -# Remove fake package and its dependencies -# -# Dependencies will removed only if no other package need them. -# -# usage: ynh_remove_app_dependencies -ynh_remove_app_dependencies () { - dep_app=${app//_/-} # Replace all '_' by '-' - ynh_package_autoremove ${dep_app}-ynh-deps # Remove the fake package and its dependencies if they not still used. -} - -# Use logrotate to manage the logfile -# -# usage: ynh_use_logrotate [logfile] -# | arg: logfile - absolute path of logfile -# -# If no argument provided, a standard directory will be use. /var/log/${app} -# You can provide a path with the directory only or with the logfile. -# /parentdir/logdir/ -# /parentdir/logdir/logfile.log -# -# It's possible to use this helper several times, each config will added to same logrotate config file. -ynh_use_logrotate () { - if [ "$#" -gt 0 ]; then - if [ "$(echo ${1##*.})" == "log" ]; then # Keep only the extension to check if it's a logfile - logfile=$1 # In this case, focus logrotate on the logfile - else - logfile=$1/.log # Else, uses the directory and all logfile into it. - fi - else - logfile="/var/log/${app}/*.log" # Without argument, use a defaut directory in /var/log - fi - cat > ./${app}-logrotate << EOF # Build a config file for logrotate -$logfile { - # Rotate if the logfile exceeds 100Mo - size 100M - # Keep 12 old log maximum - rotate 12 - # Compress the logs with gzip - compress - # Compress the log at the next cycle. So keep always 2 non compressed logs - delaycompress - # Copy and truncate the log to allow to continue write on it. Instead of move the log. - copytruncate - # Do not do an error if the log is missing - missingok - # Not rotate if the log is empty - notifempty - # Keep old logs in the same dir - noolddir -} -EOF - sudo mkdir -p $(dirname "$logfile") # Create the log directory, if not exist - cat ${app}-logrotate | sudo tee -a /etc/logrotate.d/$app > /dev/null # Append this config to the others for this app. If a config file already exist -} - -# Remove the app's logrotate config. -# -# usage: ynh_remove_logrotate -ynh_remove_logrotate () { - if [ -e "/etc/logrotate.d/$app" ]; then - sudo rm "/etc/logrotate.d/$app" - fi -} - -# Find a free port and return it -# -# example: port=$(ynh_find_port 8080) -# -# usage: ynh_find_port begin_port -# | arg: begin_port - port to start to search -ynh_find_port () { - port=$1 - test -n "$port" || ynh_die "The argument of ynh_find_port must be a valid port." - while netcat -z 127.0.0.1 $port # Check if the port is free - do - port=$((port+1)) # Else, pass to next port - done - echo $port -} - -# Create a system user -# -# usage: ynh_system_user_create user_name [home_dir] -# | arg: user_name - Name of the system user that will be create -# | arg: home_dir - Path of the home dir for the user. Usually the final path of the app. If this argument is omitted, the user will be created without home -ynh_system_user_create () { - if ! ynh_system_user_exists "$1" # Check if the user exists on the system - then # If the user doesn't exist - if [ $# -ge 2 ]; then # If a home dir is mentioned - user_home_dir="-d $2" - else - user_home_dir="--no-create-home" - fi - sudo useradd $user_home_dir --system --user-group $1 --shell /usr/sbin/nologin || ynh_die "Unable to create $1 system account" - fi -} - -# Delete a system user -# -# usage: ynh_system_user_delete user_name -# | arg: user_name - Name of the system user that will be create -ynh_system_user_delete () { - if ynh_system_user_exists "$1" # Check if the user exists on the system - then - echo "Remove the user $1" >&2 - sudo userdel $1 - else - echo "The user $1 was not found" >&2 - fi -} - -# Curl abstraction to help with POST requests to local pages (such as installation forms) -# -# $domain and $path_url should be defined externally (and correspond to the domain.tld and the /path (of the app?)) -# -# example: ynh_local_curl "/install.php?installButton" "foo=$var1" "bar=$var2" -# -# usage: ynh_local_curl "page_uri" "key1=value1" "key2=value2" ... -# | arg: page_uri - Path (relative to $path_url) of the page where POST data will be sent -# | arg: key1=value1 - (Optionnal) POST key and corresponding value -# | arg: key2=value2 - (Optionnal) Another POST key and corresponding value -# | arg: ... - (Optionnal) More POST keys and values -ynh_local_curl () { - # Define url of page to curl - full_page_url=https://localhost$path_url$1 - - # Concatenate all other arguments with '&' to prepare POST data - POST_data="" - for arg in "${@:2}" - do - POST_data="${POST_data}${arg}&" - done - if [ -n "$POST_data" ] - then - # Add --data arg and remove the last character, which is an unecessary '&' - POST_data="--data \"${POST_data::-1}\"" - fi - - # Curl the URL - curl --silent --show-error -kL -H "Host: $domain" --resolve $domain:443:127.0.0.1 $POST_data "$full_page_url" -} - -# Substitute/replace a string by another in a file -# -# usage: ynh_replace_string match_string replace_string target_file -# | arg: match_string - String to be searched and replaced in the file -# | arg: replace_string - String that will replace matches -# | arg: target_file - File in which the string will be replaced. -ynh_replace_string () { - delimit=@ - match_string=${1//${delimit}/"\\${delimit}"} # Escape the delimiter if it's in the string. - replace_string=${2//${delimit}/"\\${delimit}"} - workfile=$3 - - sudo sed --in-place "s${delimit}${match_string}${delimit}${replace_string}${delimit}g" "$workfile" -} - -# Remove a file or a directory securely -# -# usage: ynh_secure_remove path_to_remove -# | arg: path_to_remove - File or directory to remove -ynh_secure_remove () { - path_to_remove=$1 - forbidden_path=" \ - /var/www \ - /home/yunohost.app" - - if [[ "$forbidden_path" =~ "$path_to_remove" \ - # Match all paths or subpaths in $forbidden_path - || "$path_to_remove" =~ ^/[[:alnum:]]+$ \ - # Match all first level paths from / (Like /var, /root, etc...) - || "${path_to_remove:${#path_to_remove}-1}" = "/" ]] - # Match if the path finishes by /. Because it seems there is an empty variable - then - echo "Avoid deleting $path_to_remove." >&2 - else - if [ -e "$path_to_remove" ] - then - sudo rm -R "$path_to_remove" - else - echo "$path_to_remove wasn't deleted because it doesn't exist." >&2 - fi - fi -} - -# Download, check integrity, uncompress and patch the source from app.src -# -# The file conf/app.src need to contains: -# -# SOURCE_URL=Address to download the app archive -# SOURCE_SUM=Control sum -# # (Optional) Programm to check the integrity (sha256sum, md5sum$YNH_EXECUTION_DIR/...) -# # default: sha256 -# SOURCE_SUM_PRG=sha256 -# # (Optional) Archive format -# # default: tar.gz -# SOURCE_FORMAT=tar.gz -# # (Optional) Put false if source are directly in the archive root -# # default: true -# SOURCE_IN_SUBDIR=false -# # (Optionnal) Name of the local archive (offline setup support) -# # default: ${src_id}.${src_format} -# SOURCE_FILENAME=example.tar.gz -# -# Details: -# This helper download sources from SOURCE_URL if there is no local source -# archive in /opt/yunohost-apps-src/APP_ID/SOURCE_FILENAME -# -# Next, it check the integrity with "SOURCE_SUM_PRG -c --status" command. -# -# If it's ok, the source archive will be uncompress in $dest_dir. If the -# SOURCE_IN_SUBDIR is true, the first level directory of the archive will be -# removed. -# -# Finally, patches named sources/patches/${src_id}-*.patch and extra files in -# sources/extra_files/$src_id will be applyed to dest_dir -# -# -# usage: ynh_setup_source dest_dir [source_id] -# | arg: dest_dir - Directory where to setup sources -# | arg: source_id - Name of the app, if the package contains more than one app -YNH_EXECUTION_DIR="." -ynh_setup_source () { - local dest_dir=$1 - local src_id=${2:-app} # If the argument is not given, source_id equal "app" - - # Load value from configuration file (see above for a small doc about this file - # format) - local src_url=$(grep 'SOURCE_URL=' "$YNH_EXECUTION_DIR/../conf/${src_id}.src" | cut -d= -f2-) - local src_sum=$(grep 'SOURCE_SUM=' "$YNH_EXECUTION_DIR/../conf/${src_id}.src" | cut -d= -f2-) - local src_sumprg=$(grep 'SOURCE_SUM_PRG=' "$YNH_EXECUTION_DIR/../conf/${src_id}.src" | cut -d= -f2-) - local src_format=$(grep 'SOURCE_FORMAT=' "$YNH_EXECUTION_DIR/../conf/${src_id}.src" | cut -d= -f2-) - local src_in_subdir=$(grep 'SOURCE_IN_SUBDIR=' "$YNH_EXECUTION_DIR/../conf/${src_id}.src" | cut -d= -f2-) - local src_filename=$(grep 'SOURCE_FILENAME=' "$YNH_EXECUTION_DIR/../conf/${src_id}.src" | cut -d= -f2-) - - # Default value - src_sumprg=${src_sumprg:-sha256sum} - src_in_subdir=${src_in_subdir:-true} - src_format=${src_format:-tar.gz} - src_format=$(echo "$src_format" | tr '[:upper:]' '[:lower:]') - if [ "$src_filename" = "" ] ; then - src_filename="${src_id}.${src_format}" - fi - local local_src="/opt/yunohost-apps-src/${YNH_APP_ID}/${src_filename}" - - if test -e "$local_src" - then # Use the local source file if it is present - cp $local_src $src_filename - else # If not, download the source - wget -nv -O $src_filename $src_url - fi - - # Check the control sum - echo "${src_sum} ${src_filename}" | ${src_sumprg} -c --status \ - || ynh_die "Corrupt source" - - # Extract source into the app dir - sudo mkdir -p "$dest_dir" - if [ "$src_format" = "zip" ] - then - # Zip format - # Using of a temp directory, because unzip doesn't manage --strip-components - if $src_in_subdir ; then - local tmp_dir=$(mktemp -d) - sudo unzip -quo $src_filename -d "$tmp_dir" - sudo cp -a $tmp_dir/*/. "$dest_dir" - ynh_secure_remove "$tmp_dir" - else - sudo unzip -quo $src_filename -d "$dest_dir" - fi - else - local strip="" - if $src_in_subdir ; then - strip="--strip-components 1" - fi - if [[ "$src_format" =~ ^tar.gz|tar.bz2|tar.xz$ ]] ; then - sudo tar -xf $src_filename -C "$dest_dir" $strip - else - ynh_die "Archive format unrecognized." - fi - fi - - # Apply patches - if (( $(find $YNH_EXECUTION_DIR/../sources/patches/ -type f -name "${src_id}-*.patch" 2> /dev/null | wc -l) > "0" )); then - local old_dir=$(pwd) - (cd "$dest_dir" \ - && for p in $YNH_EXECUTION_DIR/../sources/patches/${src_id}-*.patch; do \ - sudo patch -p1 < $p; done) \ - || ynh_die "Unable to apply patches" - cd $old_dir - fi - - # Add supplementary files - if test -e "$YNH_EXECUTION_DIR/../sources/extra_files/${src_id}"; then - sudo cp -a $YNH_EXECUTION_DIR/../sources/extra_files/$src_id/. "$dest_dir" - fi -} - -# Check availability of a web path -# -# example: ynh_webpath_available some.domain.tld /coffee -# -# usage: ynh_webpath_available domain path -# | arg: domain - the domain/host of the url -# | arg: path - the web path to check the availability of -ynh_webpath_available () { - local domain=$1 - local path=$2 - sudo yunohost domain url-available $domain $path -} - -# Register/book a web path for an app -# -# example: ynh_webpath_register wordpress some.domain.tld /coffee -# -# usage: ynh_webpath_register app domain path -# | arg: app - the app for which the domain should be registered -# | arg: domain - the domain/host of the web path -# | arg: path - the web path to be registered -ynh_webpath_register () { - local app=$1 - local domain=$2 - local path=$3 - sudo yunohost app register-url $app $domain $path -} - -# Calculate and store a file checksum into the app settings -# -# $app should be defined when calling this helper -# -# usage: ynh_store_file_checksum file -# | arg: file - The file on which the checksum will performed, then stored. -ynh_store_file_checksum () { - local checksum_setting_name=checksum_${1//[\/ ]/_} # Replace all '/' and ' ' by '_' - ynh_app_setting_set $app $checksum_setting_name $(sudo md5sum "$1" | cut -d' ' -f1) -} - -# Verify the checksum and backup the file if it's different -# This helper is primarily meant to allow to easily backup personalised/manually -# modified config files. -# -# $app should be defined when calling this helper -# -# usage: ynh_backup_if_checksum_is_different file -# | arg: file - The file on which the checksum test will be perfomed. -# -# | ret: Return the name a the backup file, or nothing -ynh_backup_if_checksum_is_different () { - local file=$1 - local checksum_setting_name=checksum_${file//[\/ ]/_} # Replace all '/' and ' ' by '_' - local checksum_value=$(ynh_app_setting_get $app $checksum_setting_name) - if [ -n "$checksum_value" ] - then # Proceed only if a value was stored into the app settings - if ! echo "$checksum_value $file" | sudo md5sum -c --status - then # If the checksum is now different - backup_file="/home/yunohost.conf/backup/$file.backup.$(date '+%Y%m%d.%H%M%S')" - sudo mkdir -p "$(dirname "$backup_file")" - sudo cp -a "$file" "$backup_file" # Backup the current file - echo "File $file has been manually modified since the installation or last upgrade. So it has been duplicated in $backup_file" >&2 - echo "$backup_file" # Return the name of the backup file - fi - fi -} diff --git a/scripts/backup b/scripts/backup index 04aa0bf..7a22536 100644 --- a/scripts/backup +++ b/scripts/backup @@ -2,25 +2,25 @@ #================================================= # GENERIC STARTING -#================================================= -# MANAGE FAILURE OF THE SCRIPT -#================================================= - -# Exit on command errors and treat unset variables as an error -set -eu - #================================================= # IMPORT GENERIC HELPERS #================================================= if [ ! -e _common.sh ]; then - # Rapatrie le fichier de fonctions si il n'est pas dans le dossier courant - sudo cp ../settings/scripts/_common.sh ./_common.sh - sudo chmod a+rx _common.sh + # Get the _common.sh file if it's not in the current directory + cp ../settings/scripts/_common.sh ./_common.sh + chmod a+rx _common.sh fi source _common.sh source /usr/share/yunohost/helpers +#================================================= +# MANAGE SCRIPT FAILURE +#================================================= + +# Exit if an error occurs during the execution of the script +ynh_abort_if_errors + #================================================= # LOAD SETTINGS #================================================= @@ -39,20 +39,20 @@ db_pwd=$(ynh_app_setting_get $app mysqlpwd) #================================================= CHECK_SIZE "$final_path" -ynh_backup "$final_path" "${YNH_APP_BACKUP_DIR}$final_path" +ynh_backup "$final_path" #================================================= # BACKUP OF THE NGINX CONFIGURATION #================================================= -ynh_backup "/etc/nginx/conf.d/$domain.d/$app.conf" "${YNH_APP_BACKUP_DIR}/etc/nginx/conf.d/$domain.d/$app.conf" +ynh_backup "/etc/nginx/conf.d/$domain.d/$app.conf" #================================================= # BACKUP OF THE PHP-FPM CONFIGURATION #================================================= -ynh_backup "/etc/php5/fpm/pool.d/$app.conf" "${YNH_APP_BACKUP_DIR}/etc/php5/fpm/pool.d/$app.conf" -ynh_backup "/etc/php5/fpm/conf.d/20-$app.ini" "${YNH_APP_BACKUP_DIR}/etc/php5/fpm/conf.d/20-$app.ini" +ynh_backup "/etc/php5/fpm/pool.d/$app.conf" +ynh_backup "/etc/php5/fpm/conf.d/20-$app.ini" #================================================= # BACKUP OF THE SQL BDD @@ -60,4 +60,3 @@ ynh_backup "/etc/php5/fpm/conf.d/20-$app.ini" "${YNH_APP_BACKUP_DIR}/etc/php5/fp ynh_mysql_dump_db "$db_name" > db.sql CHECK_SIZE "db.sql" -# ynh_backup "db.sql" "${YNH_APP_BACKUP_DIR}/db.sql" diff --git a/scripts/install b/scripts/install index 50dd42e..97a2802 100644 --- a/scripts/install +++ b/scripts/install @@ -13,7 +13,8 @@ source /usr/share/yunohost/helpers # MANAGE FAILURE OF THE SCRIPT #================================================= -ynh_abort_if_errors # Active trap pour arrêter le script si une erreur est détectée. +# Exit if an error occurs during the execution of the script +ynh_abort_if_errors #================================================= # RETRIEVE ARGUMENTS FROM THE MANIFEST @@ -32,9 +33,16 @@ app=$YNH_APP_INSTANCE_NAME # CHECK IF THE APP CAN BE INSTALLED WITH THIS ARGS #================================================= -path_url=$(ynh_normalize_url_path $path_url) # Vérifie et corrige la syntaxe du path. -CHECK_DOMAINPATH # Vérifie la disponibilité du path et du domaine. -CHECK_FINALPATH # Vérifie que le dossier de destination n'est pas déjà utilisé. +final_path=/var/www/$app +test ! -e "$final_path" || ynh_die "This path already contains a folder" + +# Normalize the url path syntax +path_url=$(ynh_normalize_url_path $path_url) + +# Check web path availability +ynh_webpath_available $domain $path_url +# Register (book) web path +ynh_webpath_register $app $domain $path_url if [ "$path_url" == "/" ] && [ $multisite -eq 1 ]; then ynh_die "Multisite option of wordpress doesn't work at root of domain." @@ -72,25 +80,29 @@ ynh_mysql_setup_db $db_name $db_name #================================================= ynh_app_setting_set $app final_path $final_path -ynh_setup_source "$final_path" # Télécharge la source, décompresse et copie dans $final_path +# Download, check integrity, uncompress and patch the source from app.src +ynh_setup_source "$final_path" #================================================= # NGINX CONFIGURATION #================================================= -ynh_nginx_config +# Create a dedicated nginx config +ynh_add_nginx_config #================================================= # CREATE DEDICATED USER #================================================= -ynh_system_user_create $app # Créer un utilisateur système dédié à l'app +# Create a system user +ynh_system_user_create $app #================================================= # PHP-FPM CONFIGURATION #================================================= -ynh_fpm_config # Créer le fichier de configuration du pool php-fpm et le configure. +# Create a dedicated php-fpm config +ynh_add_fpm_config #================================================= # SPECIFIC SETUP @@ -98,7 +110,7 @@ ynh_fpm_config # Créer le fichier de configuration du pool php-fpm et le config # CONFIGURE WP-CONFIG #================================================= -sudo cp ../conf/wp-config.php $final_path/wp-config.php +cp ../conf/wp-config.php $final_path/wp-config.php # Change variables in Wordpress configuration ynh_replace_string "__DB_USER__" "$db_name" $final_path/wp-config.php ynh_replace_string "__DB_PWD__" "$db_pwd" $final_path/wp-config.php @@ -122,17 +134,17 @@ done #================================================= # Set right permissions for curl install -sudo chown -R $app: $final_path +chown -R $app: $final_path # Rend la page d'install publique pour curl ynh_app_setting_set $app unprotected_uris "/" -sudo yunohost app ssowatconf # Régénère la configuration de SSOwat +yunohost app ssowatconf # Régénère la configuration de SSOwat # Reload Nginx -sudo systemctl reload nginx +systemctl reload nginx # Wordpress installation -ynh_local_curl "/wp-admin/install.php?step=2" "&weblog_title=YunoBlog" "user_name=$admin_wordpress" "admin_password=$db_pwd" "admin_password2=$db_pwd" "admin_email=$admin_wordpress@$domain" "language=$language" "Submit=Install+WordPress" +ynh_local_curl "/wp-admin/install.php?step=2" "&weblog_title=YunoBlog" "user_name=$admin_wordpress" "admin_password=$db_pwd" "admin_password2=$db_pwd" "admin_email=$admin_wordpress@$domain" "Submit=Install+WordPress" WARNING echo -n "Please wait during Wordpress installation" for i in `seq 1 300` @@ -143,6 +155,18 @@ do # La boucle attend la fin de l'installation de wordpress Ou 5 minutes. WARNING echo -n "." sleep 1 done +WARNING echo "" + +#================================================= +# INSTALL WORDPRESS' PLUGINS +#================================================= + +wget -nv https://raw.githubusercontent.com/wp-cli/builds/gh-pages/phar/wp-cli.phar -O $final_path/wp-cli.phar +wpcli_alias="php $final_path/wp-cli.phar --allow-root --path=$final_path" + +$wpcli_alias plugin install simple-ldap-login +$wpcli_alias plugin install http-authentication +$wpcli_alias plugin install companion-auto-update #================================================= # LOAD SQL CONFIG @@ -150,13 +174,18 @@ done # Replace variables in sql scripts ynh_replace_string "__DOMAIN_PATH__" "$domain$path_url" ../conf/sql/*.sql -ynh_replace_string "__LANGUAGE__" "$language" ../conf/sql/*.sql ynh_replace_string "__DATE__" "$(date +%s)" ../conf/sql/*.sql # Charge les commandes sql communes à tous les scripts. -# mysql --debug-check -u $db_user -p$db_pwd $db_user < ../conf/sql/common.sql ynh_mysql_connect_as $db_name $db_pwd $db_name < ../conf/sql/common.sql +#================================================= +# SET LANGUAGE +#================================================= + +$wpcli_alias core language install $language +$wpcli_alias core language activate $language + #================================================= # CONFIGURE MULTISITE #================================================= @@ -168,42 +197,30 @@ then ynh_replace_string "//--MULTISITE1--define" "define " $final_path/wp-config.php # Active le multisite via wp-cli. - sudo wget -nv https://raw.githubusercontent.com/wp-cli/builds/gh-pages/phar/wp-cli.phar -O $final_path/wp-cli.phar - ALL_QUIET php $final_path/wp-cli.phar core multisite-convert --allow-root --path=$final_path --base=$path_url/ + ALL_QUIET $wpcli_alias core multisite-convert --base=$path_url/ # Active le multisite wordpress ynh_replace_string "//--MULTISITE2--define" "define" $final_path/wp-config.php - # Charge les commandes sql pour activer les plugins - if [ $is_public -eq 0 ] - then - ynh_replace_string "#--PRIVATE--" "" ../conf/sql/multisite.sql - else - ynh_replace_string "#--PUBLIC--" "" ../conf/sql/multisite.sql - fi ynh_mysql_connect_as $db_name $db_pwd $db_name < ../conf/sql/multisite.sql else - if [ $is_public -eq 0 ] - then - ynh_replace_string "#--PRIVATE--" "" /etc/nginx/conf.d/$domain.d/$app.conf - ynh_replace_string "#--PRIVATE--" "" ../conf/sql/single.sql - else - ynh_replace_string "//--PUBLIC--define" "define" $final_path/wp-config.php - ynh_replace_string "#--PRIVATE--" "#" /etc/nginx/conf.d/$domain.d/$app.conf - ynh_replace_string "#--PUBLIC--" "" ../conf/sql/single.sql - fi - # Charge les commandes sql pour activer les plugins ynh_mysql_connect_as $db_name $db_pwd $db_name < ../conf/sql/single.sql fi -# Décommente les add_filter, qui auraient provoqué une erreur avec wp-cli -ynh_replace_string "//add_filter" "add_filter" $final_path/wp-config.php +#================================================= +# ACTIVATE WORDPRESS' PLUGINS +#================================================= + +$wpcli_alias plugin activate simple-ldap-login +$wpcli_alias plugin activate http-authentication +$wpcli_alias plugin activate companion-auto-update #================================================= # STORE THE CHECKSUM OF THE CONFIG FILE #================================================= -ynh_store_file_checksum "$final_path/wp-config.php" # Enregistre la somme de contrôle du fichier de config +# Calculate and store the config file checksum into the app settings +ynh_store_file_checksum "$final_path/wp-config.php" #================================================= # GENERIC FINALISATION @@ -212,9 +229,9 @@ ynh_store_file_checksum "$final_path/wp-config.php" # Enregistre la somme de con #================================================= # Les fichiers appartiennent à l'user wordpress, pour permettre les mises à jour. -sudo chown -R $app: $final_path +chown -R $app: $final_path # Sauf le fichier de config wp-config.php qui appartient à root -sudo chown root: $final_path/wp-config.php +chown root: $final_path/wp-config.php #================================================= # SETUP SSOWAT @@ -230,11 +247,10 @@ fi # RELOAD NGINX #================================================= -sudo systemctl reload nginx +systemctl reload nginx #================================================= # REMOVE WP-CLI.PHAR #================================================= -# wp-cli me semble un peu trop permissif... Il a terminé son travail... ynh_secure_remove $final_path/wp-cli.phar diff --git a/scripts/remove b/scripts/remove index 6b00dfa..2126460 100755 --- a/scripts/remove +++ b/scripts/remove @@ -24,31 +24,36 @@ db_name=$(ynh_app_setting_get $app db_name) # REMOVE DEPENDENCIES #================================================= +# Remove metapackage and its dependencies ynh_remove_app_dependencies #================================================= # REMOVE THE SQL BDD #================================================= -ynh_mysql_remove_db $db_name $db_name # Suppression de la base de donnée et de l'utilisateur associé. +# Remove a database if it exists, along with the associated user +ynh_mysql_remove_db $db_name $db_name #================================================= # REMOVE THE MAIN DIR OF THE APP #================================================= -ynh_secure_remove "/var/www/$app" # Suppression du dossier de l'application +# Remove the app directory securely +ynh_secure_remove "/var/www/$app" #================================================= # REMOVE THE NGINX CONFIGURATION #================================================= -ynh_remove_nginx_config # Suppression de la configuration nginx +# Remove the dedicated nginx config +ynh_remove_nginx_config #================================================= # REMOVE THE PHP-FPM CONFIGURATION #================================================= -ynh_remove_fpm_config # Suppression de la configuration du pool php-fpm +# Remove the dedicated php-fpm config +ynh_remove_fpm_config #================================================= # GENERIC FINALISATION @@ -56,4 +61,5 @@ ynh_remove_fpm_config # Suppression de la configuration du pool php-fpm # REMOVE DEDICATED USER #================================================= +# Delete a system user ynh_system_user_delete $app diff --git a/scripts/restore b/scripts/restore index defa554..2d6cdea 100644 --- a/scripts/restore +++ b/scripts/restore @@ -2,25 +2,25 @@ #================================================= # GENERIC STARTING -#================================================= -# MANAGE FAILURE OF THE SCRIPT -#================================================= - -# Exit on command errors and treat unset variables as an error -set -eu - #================================================= # IMPORT GENERIC HELPERS #================================================= if [ ! -e _common.sh ]; then - # Rapatrie le fichier de fonctions si il n'est pas dans le dossier courant - sudo cp ../settings/scripts/_common.sh ./_common.sh - sudo chmod a+rx _common.sh + # Get the _common.sh file if it's not in the current directory + cp ../settings/scripts/_common.sh ./_common.sh + chmod a+rx _common.sh fi source _common.sh source /usr/share/yunohost/helpers +#================================================= +# MANAGE SCRIPT FAILURE +#================================================= + +# Exit if an error occurs during the execution of the script +ynh_abort_if_errors + #================================================= # LOAD SETTINGS #================================================= @@ -37,7 +37,7 @@ db_name=$(ynh_app_setting_get $app db_name) # CHECK IF THE APP CAN BE RESTORED #================================================= -sudo yunohost app checkurl "${domain}${path_url}" -a "$app" \ +ynh_webpath_available $domain $path_url \ || ynh_die "Path not available: ${domain}${path_url}" test ! -d $final_path \ || ynh_die "There is already a directory: $final_path " @@ -75,9 +75,9 @@ ynh_system_user_create $app # Recreate the dedicated user, if not exist #================================================= # Les fichiers appartiennent à l'user wordpress, pour permettre les mises à jour. -sudo chown -R $app: $final_path +chown -R $app: $final_path # Sauf le fichier de config wp-config.php qui appartient à root -sudo chown root: $final_path/wp-config.php +chown root: $final_path/wp-config.php #================================================= # RESTORE OF THE PHP-FPM CONFIGURATION @@ -92,5 +92,5 @@ ynh_restore_file "/etc/php5/fpm/conf.d/20-$app.ini" # RELOAD NGINX AND PHP-FPM #================================================= -sudo systemctl reload php5-fpm -sudo systemctl reload nginx +systemctl reload php5-fpm +systemctl reload nginx diff --git a/scripts/upgrade b/scripts/upgrade index 811d0e9..4af99ef 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -14,6 +14,7 @@ source /usr/share/yunohost/helpers #================================================= app=$YNH_APP_INSTANCE_NAME + domain=$(ynh_app_setting_get $app domain) path_url=$(ynh_app_setting_get $app path) admin_wordpress=$(ynh_app_setting_get $app admin) @@ -24,7 +25,7 @@ final_path=$(ynh_app_setting_get $app final_path) db_name=$(ynh_app_setting_get $app db_name) #================================================= -# FIX OLD THINGS +# ENSURE DOWNWARD COMPATIBILITY #================================================= if [ -z "$admin_wordpress" ]; then @@ -40,7 +41,7 @@ if [ -z "$final_path" ]; then fi if [ -z "$language" ]; then - language=$(sudo grep WPLANG $final_path/wp-config.php | cut -d"'" -f4) + language=$(grep WPLANG $final_path/wp-config.php | cut -d"'" -f4) ynh_app_setting_set $app language $language fi @@ -65,46 +66,61 @@ if [ -z $db_name ]; then # Si db_name n'est pas renseigné dans app setting ynh_app_setting_set $app db_name $db_name fi +if grep add_filter.*auto_update $final_path/wp-config.php; then # Si des add_filter demeurent dans le wp-config + sed --in-place '/add_filter.*auto_update/d' $final_path/wp-config.php +fi + +#================================================= +# STANDARD UPGRADE STEPS #================================================= # BACKUP BEFORE UPGRADE THEN ACTIVE TRAP #================================================= -BACKUP_BEFORE_UPGRADE # Backup the current version of the app +# Backup the current version of the app +ynh_backup_before_upgrade ynh_clean_setup () { - BACKUP_FAIL_UPGRADE # restore it if the upgrade fails + # restore it if the upgrade fails + ynh_restore_upgradebackup } -ynh_abort_if_errors # Active trap pour arrêter le script si une erreur est détectée. +# Exit if an error occurs during the execution of the script +ynh_abort_if_errors #================================================= # CHECK THE PATH #================================================= -path_url=$(ynh_normalize_url_path $path_url) # Vérifie et corrige la syntaxe du path. +# Normalize the URL path syntax +path_url=$(ynh_normalize_url_path $path_url) #================================================= # NGINX CONFIGURATION #================================================= -ynh_nginx_config +# Create a dedicated nginx config +ynh_add_nginx_config #================================================= # CREATE DEDICATED USER #================================================= -ynh_system_user_create $app # Create the dedicated user, if not exist +# Create the dedicated user, if not exist +ynh_system_user_create $app #================================================= # PHP-FPM CONFIGURATION #================================================= -ynh_fpm_config # Créer le fichier de configuration du pool php-fpm et le configure. +# Create a dedicated php-fpm config +ynh_add_fpm_config #================================================= # SPECIFIC UPGRADE #================================================= # SAVE THE CONFIG FILE IF IT BEEN MODIFIED #================================================= -ynh_backup_if_checksum_is_different "$final_path/wp-config.php" # Créé un backup du fichier de config si il a été modifié. + +# Verify the checksum and backup the file if it's different +ynh_backup_if_checksum_is_different "$final_path/wp-config.php" #================================================= # CONFIGURE MULTISITE @@ -124,11 +140,26 @@ else fi ynh_app_setting_set $app multisite $multisite +#================================================= +# UPDATE WORDPRESS' PLUGINS +#================================================= + +wget -nv https://raw.githubusercontent.com/wp-cli/builds/gh-pages/phar/wp-cli.phar -O $final_path/wp-cli.phar +wpcli_alias="php $final_path/wp-cli.phar --allow-root --path=$final_path" +update_plugin () { + ( $wpcli_alias plugin is-installed $1 && $wpcli_alias plugin update $1 ) || $wpcli_alias plugin install $1 +} +update_plugin simple-ldap-login +update_plugin http-authentication +update_plugin companion-auto-update +$wpcli_alias plugin activate companion-auto-update + #================================================= # STORE THE CHECKSUM OF THE CONFIG FILE #================================================= -ynh_store_file_checksum "$final_path/wp-config.php" # Réenregistre la somme de contrôle du fichier de config +# Recalculate and store the config file checksum into the app settings +ynh_store_file_checksum "$final_path/wp-config.php" #================================================= # GENERIC FINALISATION @@ -137,9 +168,9 @@ ynh_store_file_checksum "$final_path/wp-config.php" # Réenregistre la somme de #================================================= # Les fichiers appartiennent à l'user wordpress, pour permettre les mises à jour. -sudo chown -R $app: $final_path +chown -R $app: $final_path # Sauf le fichier de config wp-config.php qui appartient à root -sudo chown root: $final_path/wp-config.php +chown root: $final_path/wp-config.php #================================================= # SETUP SSOWAT @@ -156,4 +187,10 @@ fi # RELOAD NGINX #================================================= -sudo systemctl reload nginx +systemctl reload nginx + +#================================================= +# REMOVE WP-CLI.PHAR +#================================================= + +ynh_secure_remove $final_path/wp-cli.phar diff --git a/sources/extra_files/wp-content/plugins/http-authentication/http-authentication.php b/sources/extra_files/wp-content/plugins/http-authentication/http-authentication.php deleted file mode 100644 index 2e99a1b..0000000 --- a/sources/extra_files/wp-content/plugins/http-authentication/http-authentication.php +++ /dev/null @@ -1,278 +0,0 @@ -REMOTE_USER). This plugin assumes users are externally authenticated, as with GatorLink. -Author: Daniel Westermann-Clark -Author URI: http://danieltwc.com/ -*/ - -require_once(dirname(__FILE__) . DIRECTORY_SEPARATOR . 'options-page.php'); - -class HTTPAuthenticationPlugin { - var $db_version = 2; - var $option_name = 'http_authentication_options'; - var $options; - - function HTTPAuthenticationPlugin() { - $this->options = get_option($this->option_name); - - if (is_admin()) { - $options_page = new HTTPAuthenticationOptionsPage($this, $this->option_name, __FILE__, $this->options); - add_action('admin_init', array($this, 'check_options')); - } - - add_action('login_head', array($this, 'add_login_css')); - add_action('login_footer', array($this, 'add_login_link')); - add_action('check_passwords', array($this, 'generate_password'), 10, 3); - add_action('wp_logout', array($this, 'logout')); - add_filter('login_url', array($this, 'bypass_reauth')); - add_filter('show_password_fields', array($this, 'allow_wp_auth')); - add_filter('allow_password_reset', array($this, 'allow_wp_auth')); - add_filter('authenticate', array($this, 'authenticate'), 10, 3); - } - - /* - * Check the options currently in the database and upgrade if necessary. - */ - function check_options() { - if ($this->options === false || ! isset($this->options['db_version']) || $this->options['db_version'] < $this->db_version) { - if (! is_array($this->options)) { - $this->options = array(); - } - - $current_db_version = isset($this->options['db_version']) ? $this->options['db_version'] : 0; - $this->upgrade($current_db_version); - $this->options['db_version'] = $this->db_version; - update_option($this->option_name, $this->options); - } - } - - /* - * Upgrade options as needed depending on the current database version. - */ - function upgrade($current_db_version) { - $default_options = array( - 'allow_wp_auth' => false, - 'auth_label' => 'HTTP authentication', - 'login_uri' => htmlspecialchars_decode(wp_login_url()), - 'logout_uri' => remove_query_arg('_wpnonce', htmlspecialchars_decode(wp_logout_url())), - 'additional_server_keys' => '', - 'auto_create_user' => false, - 'auto_create_email_domain' => '', - ); - - if ($current_db_version < 1) { - foreach ($default_options as $key => $value) { - // Handle migrating existing options from before we stored a db_version - if (! isset($this->options[$key])) { - $this->options[$key] = $value; - } - } - } - } - - function add_login_css() { -?> - -_generate_uri($this->options['login_uri'], wp_login_url($redirect_to)); - $auth_label = $this->options['auth_label']; - - echo "\t" . '' . "\n"; - } - - /* - * Generate a password for the user. This plugin does not require the - * administrator to enter this value, but we need to set it so that user - * creation and editing works. - */ - function generate_password($username, $password1, $password2) { - if (! $this->allow_wp_auth()) { - $password1 = $password2 = wp_generate_password(); - } - } - - /* - * Logout the user by redirecting them to the logout URI. - */ - function logout() { - $logout_uri = $this->_generate_uri($this->options['logout_uri'], home_url()); - - wp_redirect($logout_uri); - exit(); - } - - /* - * Remove the reauth=1 parameter from the login URL, if applicable. This allows - * us to transparently bypass the mucking about with cookies that happens in - * wp-login.php immediately after wp_signon when a user e.g. navigates directly - * to wp-admin. - */ - function bypass_reauth($login_url) { - $login_url = remove_query_arg('reauth', $login_url); - - return $login_url; - } - - /* - * Can we fallback to built-in WordPress authentication? - */ - function allow_wp_auth() { - return (bool) $this->options['allow_wp_auth']; - } - - /* - * Authenticate the user, first using the external authentication source. - * If allowed, fall back to WordPress password authentication. - */ - function authenticate($user, $username, $password) { - $user = $this->check_remote_user(); - - if (! is_wp_error($user)) { - // User was authenticated via REMOTE_USER - $user = new WP_User($user->ID); - } - else { - // REMOTE_USER is invalid; now what? - - if (! $this->allow_wp_auth()) { - // Bail with the WP_Error when not falling back to WordPress authentication - wp_die($user); - } - - // Fallback to built-in hooks (see wp-includes/user.php) - } - - return $user; - } - - /* - * If the REMOTE_USER or REDIRECT_REMOTE_USER evironment variable is set, use it - * as the username. This assumes that you have externally authenticated the user. - */ - function check_remote_user() { - $username = ''; - - $server_keys = $this->_get_server_keys(); - foreach ($server_keys as $server_key) { - if (! empty($_SERVER[$server_key])) { - $username = $_SERVER[$server_key]; - } - } - - if (! $username) { - return new WP_Error('empty_username', 'ERROR: No user found in server variables.'); - } - - // Create new users automatically, if configured - $user = get_user_by('login', $username); - if (! $user) { - if ((bool) $this->options['auto_create_user']) { - $user = $this->_create_user($username); - } - else { - // Bail out to avoid showing the login form - $user = new WP_Error('authentication_failed', __('ERROR: Invalid username or incorrect password.')); - } - } - - return $user; - } - - /* - * Return the list of $_SERVER keys that we will check for a username. By - * default, these are REMOTE_USER and REDIRECT_REMOTE_USER. Additional keys - * can be configured from the options page. - */ - function _get_server_keys() { - $server_keys = array('REMOTE_USER', 'REDIRECT_REMOTE_USER'); - - $additional_server_keys = $this->options['additional_server_keys']; - if (! empty($additional_server_keys)) { - $keys = preg_split('/,\s*/', $additional_server_keys); - $server_keys = array_merge($server_keys, $keys); - } - - return $server_keys; - } - - /* - * Create a new WordPress account for the specified username. - */ - function _create_user($username) { - $password = wp_generate_password(); - $email_domain = $this->options['auto_create_email_domain']; - - $user_id = wp_create_user($username, $password, $username . ($email_domain ? '@' . $email_domain : '')); - $user = get_user_by('id', $user_id); - - return $user; - } - - /* - * Fill the specified URI with the site URI and the specified return location. - */ - function _generate_uri($uri, $redirect_to) { - // Support tags for staged deployments - $base = $this->_get_base_url(); - - $tags = array( - 'host' => $_SERVER['HTTP_HOST'], - 'base' => $base, - 'site' => home_url(), - 'redirect' => $redirect_to, - ); - - foreach ($tags as $tag => $value) { - $uri = str_replace('%' . $tag . '%', $value, $uri); - $uri = str_replace('%' . $tag . '_encoded%', urlencode($value), $uri); - } - - // Support previous versions with only the %s tag - if (strstr($uri, '%s') !== false) { - $uri = sprintf($uri, urlencode($redirect_to)); - } - - return $uri; - } - - /* - * Return the base domain URL based on the WordPress home URL. - */ - function _get_base_url() { - $home = parse_url(home_url()); - - $base = home_url(); - foreach (array('path', 'query', 'fragment') as $key) { - if (! isset($home[$key])) continue; - $base = str_replace($home[$key], '', $base); - } - - return $base; - } -} - -// Load the plugin hooks, etc. -$http_authentication_plugin = new HTTPAuthenticationPlugin(); -?> diff --git a/sources/extra_files/wp-content/plugins/http-authentication/options-page.php b/sources/extra_files/wp-content/plugins/http-authentication/options-page.php deleted file mode 100644 index f670ee2..0000000 --- a/sources/extra_files/wp-content/plugins/http-authentication/options-page.php +++ /dev/null @@ -1,195 +0,0 @@ -plugin = $plugin; - $this->group = $group; - $this->page = $page; - $this->options = $options; - $this->title = $title; - - add_action('admin_init', array($this, 'register_options')); - add_action('admin_menu', array($this, 'add_options_page')); - } - - /* - * Register the options for this plugin so they can be displayed and updated below. - */ - function register_options() { - register_setting($this->group, $this->group, array($this, 'sanitize_settings')); - - $section = 'http_authentication_main'; - add_settings_section($section, 'Main Options', array($this, '_display_options_section'), $this->page); - add_settings_field('http_authentication_allow_wp_auth', 'Allow WordPress authentication?', array($this, '_display_option_allow_wp_auth'), $this->page, $section, array('label_for' => 'http_authentication_allow_wp_auth')); - add_settings_field('http_authentication_auth_label', 'Authentication label', array($this, '_display_option_auth_label'), $this->page, $section, array('label_for' => 'http_authentication_auth_label')); - add_settings_field('http_authentication_login_uri', 'Login URI', array($this, '_display_option_login_uri'), $this->page, $section, array('label_for' => 'http_authentication_login_uri')); - add_settings_field('http_authentication_logout_uri', 'Logout URI', array($this, '_display_option_logout_uri'), $this->page, $section, array('label_for' => 'http_authentication_logout_uri')); - add_settings_field('http_authentication_additional_server_keys', '$_SERVER variables', array($this, '_display_option_additional_server_keys'), $this->page, $section, array('label_for' => 'http_authentication_additional_server_keys')); - add_settings_field('http_authentication_auto_create_user', 'Automatically create accounts?', array($this, '_display_option_auto_create_user'), $this->page, $section, array('label_for' => 'http_authentication_auto_create_user')); - add_settings_field('http_authentication_auto_create_email_domain', 'Email address domain', array($this, '_display_option_auto_create_email_domain'), $this->page, $section, array('label_for' => 'http_authentication_auto_create_email_domain')); - } - - /* - * Set the database version on saving the options. - */ - function sanitize_settings($input) { - $output = $input; - $output['db_version'] = $this->plugin->db_version; - $output['allow_wp_auth'] = isset($input['allow_wp_auth']) ? (bool) $input['allow_wp_auth'] : false; - $output['auto_create_user'] = isset($input['auto_create_user']) ? (bool) $input['auto_create_user'] : false; - - return $output; - } - - /* - * Add an options page for this plugin. - */ - function add_options_page() { - add_options_page($this->title, $this->title, 'manage_options', $this->page, array($this, '_display_options_page')); - } - - /* - * Display the options for this plugin. - */ - function _display_options_page() { - if (! current_user_can('manage_options')) { - wp_die(__('You do not have sufficient permissions to access this page.')); - } -?> -
-

HTTP Authentication Options

-

For the Login URI and Logout URI options, you can use the following variables to support your installation:

- -

You can also use %host_encoded%, %site_encoded%, and %redirect_encoded% for URL-encoded values.

-
- - group); ?> - page); ?> -

- -

-
-
-options['allow_wp_auth']; - $this->_display_checkbox_field('allow_wp_auth', $allow_wp_auth); -?> -Should the plugin fallback to WordPress authentication if none is found from the server? -options['login_uri'] == htmlspecialchars_decode(wp_login_url())) { - echo '
WARNING: You must set the login URI below to your external authentication system. Otherwise you will not be able to login!'; - } - } - - /* - * Display the authentication label field, describing the authentication system - * in use. - */ - function _display_option_auth_label() { - $auth_label = $this->options['auth_label']; - $this->_display_input_text_field('auth_label', $auth_label); -?> -Default is HTTP authentication; override to use the name of your single sign-on system. -options['login_uri']; - $this->_display_input_text_field('login_uri', $login_uri); -?> -Default is ; override to direct users to a single sign-on system. See above for available variables.
-Example: %base%/Shibboleth.sso/Login?target=%redirect_encoded% -options['logout_uri']; - $this->_display_input_text_field('logout_uri', $logout_uri); -?> -Default is ; override to e.g. remove a cookie. See above for available variables.
-Example: %base%/Shibboleth.sso/Logout?return=%redirect_encoded% -options['additional_server_keys']; - $this->_display_input_text_field('additional_server_keys', $additional_server_keys); -?> -$_SERVER variables in addition to REMOTE_USER and REDIRECT_REMOTE_USER to check for the username value, separated by a comma. Use this to e.g. support personal X.509 certificates for authentication.
-Example: SSL_CLIENT_S_DN_CN -options['auto_create_user']; - $this->_display_checkbox_field('auto_create_user', $auto_create_user); -?> -Should a new user be created automatically if not already in the WordPress database?
-Created users will obtain the role defined under "New User Default Role" on the General Options page. -options['auto_create_email_domain']; - $this->_display_input_text_field('auto_create_email_domain', $auto_create_email_domain); -?> -When a new user logs in, this domain is used for the initial email address on their account. The user can change his or her email address by editing their profile. - -
- - value="1" />
- diff --git a/sources/extra_files/wp-content/plugins/http-authentication/readme.txt b/sources/extra_files/wp-content/plugins/http-authentication/readme.txt deleted file mode 100644 index 8f14186..0000000 --- a/sources/extra_files/wp-content/plugins/http-authentication/readme.txt +++ /dev/null @@ -1,202 +0,0 @@ -=== HTTP Authentication === -Contributors: dwc -Tags: authentication -Requires at least: 3.1 -Tested up to: 3.4 -Stable tag: 4.5 - -Use an external authentication source in WordPress. - -== Description == - -The HTTP Authentication plugin allows you to use existing means of authenticating people to WordPress. This includes Apache's basic HTTP authentication module, [Shibboleth](http://shibboleth.internet2.edu/), and many others. - -To follow updates to this plugin, visit: - -http://danieltwc.com/ - -For help with this version, visit: - -http://danieltwc.com/2011/http-authentication-4-0/ - -== Installation == - -1. Login as an existing user, such as admin. -2. Upload the `http-authentication` folder to your plugins folder, usually `wp-content/plugins`. (Or simply via the built-in installer.) -3. Activate the plugin on the Plugins screen. -4. Add one or more users to WordPress, specifying the external username for the "Username" field. Also be sure to set the role for each user. -5. Logout. -6. Protect `wp-login.php` and `wp-admin` using your external authentication (using, for example, `.htaccess` files). -7. Try logging in as one of the users added in step 4. - -Note: This version works with WordPress 3.0 and above. Use the following for older versions of WordPress: - -* Wordpress 2.0: [Version 1.8](http://downloads.wordpress.org/plugin/http-authentication.1.8.zip) -* Wordpress 2.5 through 2.9.x: [Version 2.4](http://downloads.wordpress.org/plugin/http-authentication.2.4.zip) - -== Frequently Asked Questions == - -= What authentication mechanisms can I use? = - -Any authentication mechanism which sets the `REMOTE_USER` (or `REDIRECT_REMOTE_USER`, in the case of ScriptAlias'd PHP-as-CGI) environment variable can be used in conjunction with this plugin. Examples include Apache's `mod_auth` and `mod_auth_ldap`. - -= How should I set up external authentication? = - -This depends on your hosting environment and your means of authentication. - -Many Apache installations allow configuration of authentication via `.htaccess` files, while some do not. Try adding the following to your blog's top-level `.htaccess` file: -` -AuthName "WordPress" -AuthType Basic -AuthUserFile /path/to/passwords -Require user dwc -` - -(You may also want to protect your `xmlrpc.php` file, which uses separate authentication code.) - -Then, create another `.htaccess` file in your `wp-admin` directory with the following contents: -`AuthName "WordPress" -AuthType Basic -AuthUserFile /path/to/passwords -Require user dwc` - -In both files, be sure to set `/path/to/passwords` to the location of your password file. For more information on creating this file, see below. - -= Where can I find more information on configuring Apache authentication? = - -See Apache's HOWTO: [Authentication, Authorization, and Access Control](http://httpd.apache.org/docs/howto/auth.html). - -= How does this plugin authenticate users? = - -This plugin doesn't actually authenticate users. It simply feeds WordPress the name of a user who has successfully authenticated through Apache. - -To determine the username, this plugin uses the `REMOTE_USER` or the `REDIRECT_REMOTE_USER` environment variable, which is set by many Apache authentication modules. If someone can find a way to spoof this value, this plugin is not guaranteed to be secure. - -By default, this plugin generates a random password each time you create a user or edit an existing user's profile. However, since this plugin requires an external authentication mechanism, this password is not requested by WordPress. Generating a random password helps protect accounts, preventing one authorized user from pretending to be another. - -= If I disable this plugin, how will I login? = - -Because this plugin generates a random password when you create a new user or edit an existing user's profile, you will most likely have to reset each user's password if you disable this plugin. WordPress provides a link for requesting a new password on the login screen. - -Also, you should leave the `admin` user as a fallback, i.e. create a new account to use with this plugin. As long as you don't edit the `admin` profile, WordPress will store the password set when you installed WordPress. - -In the worst case scenario, you may have to use phpMyAdmin or the MySQL command line to [reset a user's password](http://codex.wordpress.org/Resetting_Your_Password). - -= Can I configure the plugin to support standard WordPress logins? = - -Yes. You can authenticate some users via an external, single sign-on system and other users via the built-in username and password combination. (Note: When mixed authentication is in use, this plugin does not scramble passwords as described above.) - -When you configure your external authentication system, make sure that you allow users in even if they have not authenticated externally. Using [Shibboleth](http://shibboleth.internet2.edu/) as an example: -`AuthName "Shibboleth" -AuthType Shibboleth -Require Shibboleth` - -This enables Shibboleth authentication in ["passive" mode](https://wiki.shibboleth.net/confluence/display/SHIB2/NativeSPProtectContent). - -Then, in WordPress: - -1. Set the plugin to allow WordPress authentication. -2. Configure the login URI to match your Shibboleth system. For example, if your blog is hosted at `http://example.com/`, then your login URI should be `http://example.com/Shibboleth.sso/Login?target=%redirect_encoded%`. -3. Configure the logout URI to match your Shibboleth system. Following the above example, your logout URI would be `http://example.com/Shibboleth.sso/Logout?return=%redirect_encoded%`. - -After saving the options, authentication will work as follows: - -* If a user is already authenticated via Shibboleth, and he or she exists in the WordPress database, this plugin will log them in automatically. -* If a user is not authenticated via Shibboleth, the plugin will present the standard WordPress login form with an additional link to login via Shibboleth. - -Other authentication systems (particularly those without a login or logout URI) will need to be configured differently. - -= Does this plugin support multisite (WordPress MU) setups? = - -Yes, you can enable this plugin across a network or on individual sites. However, options will need to be set on individual sites. - -If you have suggestions on how to improve network support, please submit a comment. - -= How do you handle staged deployments (dev, test, prod) with the plugin? = - -If you have a WordPress site with multiple environments (e.g. `dev.example.com`, `test.example.com`, and `example.com`) you can use additional variables in the login and logout URIs: - -* `%host%` - The current value of `$_SERVER['HTTP_HOST']` -* `%base%` - The base domain URL (everything before the path) -* `%site%` - The WordPress home URI -* `%redirect%` - The return URI provided by WordPress - -You can also use `%host_encoded%`, `%site_encoded%`, and `%redirect_encoded%` for URL-encoded values. - -For example, your login URI could be: - -`https://%host%/Shibboleth.sso/Login?target=%redirect_encoded%` - -This would be modified for each environment as appropriate. - -== Screenshots == - -1. Plugin options, allowing WordPress authentication -2. WordPress login form with external authentication link - -== Changelog == - -= 4.5 = -* Avoid some PHP notices due to saving options (William Schneider) -* Fix for redirect loop on some multisite setups (#1497) -* Add option to support additional $_SERVER variables in authentication (#1477) -* Remove use of call-time pass by reference to avoid warnings on PHP 5.3 and newer -* Fix deprecation notice in WordPress 3.3 on `get_userdatabylogin` (#1513) -* Fix deprecation notice in WordPress 3.1 and later for including wp-includes/registration.php -* Associate options page label tags with their input fields (#1514) - -= 4.4 = -* Update CSS to correctly center login button on WordPress 3.3 - -= 4.3 = -* Update plugin URIs - -= 4.2 = -* Declare support for WordPress 3.2.1 -* Extend variable replacement for staged deployments -* Wrap redirect parameter on login to force us through `wp-login.php` so we can check the external authentication (thanks to Josh Larios) - -= 4.1 = -* Declare support for WordPress 3.2 -* Update screenshots for WordPress 3.2 - -= 4.0 = -* Restore (and improve) support for falling back to WordPress password authentication -* Remove migration of old options format (we'll assume enough people have upgraded) - -= 3.3 = -* Update options handling to better support WordPress MU - -= 3.2 = -* Restore password generation for adding and editing users - -= 3.1 = -* Bump version number to make 3.0.1 the latest version on wordpress.org - -= 3.0.1 = -* Handle authentication cookies more gracefully - -= 3.0 = -* Add support for WordPress 3.0 -* Update WordPress MU support for WordPress 3.0 - -= 2.4 = -* Add support for WordPress MU (Elliot Kendall) -* Allow for mixed HTTP and built-in authentication by falling back to wp-login.php (Elliot Kendall) - -== Upgrade Notice == - -= 4.5 = -Avoid some PHP errors and warnings; add support for choosing $_SERVER variables - -= 4.4 = -Minor CSS fix for WordPress 3.3 - -= 4.3 = -No code changes; updating plugin URIs - -= 4.2 = -Extends support for variable replacement - -= 4.1 = -Minor update for WordPress 3.2 diff --git a/sources/extra_files/wp-content/plugins/http-authentication/screenshot-1.png b/sources/extra_files/wp-content/plugins/http-authentication/screenshot-1.png deleted file mode 100644 index 20635ee..0000000 Binary files a/sources/extra_files/wp-content/plugins/http-authentication/screenshot-1.png and /dev/null differ diff --git a/sources/extra_files/wp-content/plugins/http-authentication/screenshot-2.png b/sources/extra_files/wp-content/plugins/http-authentication/screenshot-2.png deleted file mode 100644 index f9d4cdd..0000000 Binary files a/sources/extra_files/wp-content/plugins/http-authentication/screenshot-2.png and /dev/null differ diff --git a/sources/extra_files/wp-content/plugins/simple-ldap-login/Simple-LDAP-Login-Admin.php b/sources/extra_files/wp-content/plugins/simple-ldap-login/Simple-LDAP-Login-Admin.php deleted file mode 100644 index 8855739..0000000 --- a/sources/extra_files/wp-content/plugins/simple-ldap-login/Simple-LDAP-Login-Admin.php +++ /dev/null @@ -1,238 +0,0 @@ - -
- -
-

Simple LDAP Login Settings

- -

- Simple - Advanced - User - Help -

- -
- - - -

Required

-

These are the most basic settings you must configure. Without these, you won't be able to use Simple LDAP Login.

- - - - - - - - - - - - - - - - - - - - - - - -
Enable LDAP Authentication - -
-
Account Suffix -
- Often the suffix of your e-mail address. Example: @gmail.com -
Base DN - -
- Example: For subdomain.domain.suffix, use DC=subdomain,DC=domain,DC=suffix. In most cases you should not specify an ou here. -
Domain Controller(s) - -
Separate with semi-colons. -
LDAP Directory -
- -
-

- -

Typical

-

These settings give you finer control over how logins work.

- - - - - - - - - - - - - - - - - - -
Required Groups -
- The groups, if any, that authenticating LDAP users must belong to.
- Empty means no group required. Separate with semi-colons. -
LDAP Exclusive - -
-
User Creations - -
-
New User Role - -
-
-

Extraordinary

-

Most users should leave these alone.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Group Base DN (optional) - -
- If you need to specify a different Base DN for group searches. Example: For subdomain.domain.suffix, use ou=groups,DC=subdomain,DC=domain,DC=suffix. -
LDAP Login Attribute - -
- Default: uid; -
LDAP Group Attribute - -
- In case your installation uses something other than cn; -
Use TLS - -
-
LDAP Port -
- This is usually 389. -
LDAP Version -
- Only applies to Open LDAP. Typically 3. -
Search Sub OUs - -
-
Login Domain -
- prefixes login names with this domain, f.i. mydomain\username -
-

- -

User Data

-

These settings give you control over which LDAP attributes are used for user creation.

- - - - - - - - - - - - - - - - - - - -
First name - -
- The LDAP attribute for the first name. -
Last name - -
- The LDAP attribute for the last name. -
Email - -
- The LDAP attribute for the email. -
Website - -
- The LDAP attribute for the website. -
-
-

Additional user data

-

Additional user data can be stored as user meta data. You can specify the LDAP - attributes and the associated wordpress meta keys in the format <ldap_attribute_name>:<wordpress_meta_key>. Multiple attributes can be given on separate lines.

-

Example:
phone:user_phone_number
adress:user_home_address

- - - - - - - -
Meta data - -
-

- -

Help

-

Here's a brief primer on how to effectively use and test Simple LDAP Login.

-

Testing

-

The most effective way to test logins is to use two browsers. In other words, keep the WordPress Dashboard open in Chrome, and use Firefox to try logging in. This will give you real time feedback on your settings and prevent you from inadvertently locking yourself out.

-

Which raises the question, what happens if I get locked out?

-

If you accidentally lock yourself out, the easiest way to get back in is to rename to something else and then refresh. WordPress will detect the change and disable Simple LDAP Login. You can then rename the folder back to its previous name.

- -
-
diff --git a/sources/extra_files/wp-content/plugins/simple-ldap-login/Simple-LDAP-Login.php b/sources/extra_files/wp-content/plugins/simple-ldap-login/Simple-LDAP-Login.php deleted file mode 100644 index 997985d..0000000 --- a/sources/extra_files/wp-content/plugins/simple-ldap-login/Simple-LDAP-Login.php +++ /dev/null @@ -1,563 +0,0 @@ -settings = $this->get_settings_obj( $this->prefix ); - - if( $this->get_setting('directory') == "ad" ) { - require_once( plugin_dir_path(__FILE__) . "/includes/adLDAP.php" ); - $this->adldap = new adLDAP( - array ( - "account_suffix" => $this->get_setting('account_suffix'), - "use_tls" => str_true( $this->get_setting('use_tls') ), - "base_dn" => $this->get_setting('base_dn'), - "domain_controllers" => (array)$this->get_setting('domain_controllers'), - "ad_port" => $this->get_setting('ldap_port') - ) - ); - } - - add_action('admin_init', array($this, 'save_settings') ); - - if ($this->is_network_version()) { - add_action('network_admin_menu', array($this, 'menu') ); - } - else { - add_action('admin_menu', array($this, 'menu') ); - } - - - if ( str_true($this->get_setting('enabled')) ) { - add_filter('authenticate', array($this, 'authenticate'), 1, 3); - } - - register_activation_hook( __FILE__, array($this, 'activate') ); - - // If version is false, and old version detected, run activation - if( $this->get_setting('version') === false || $this->get_setting('version') != $version ) { - $this->upgrade_settings(); - } - } - - public static function getInstance () { - if ( !self::$instance ) { - self::$instance = new self; - } - return self::$instance; - } - - function activate () { - // Default settings - $this->add_setting('account_suffix', "@mydomain.org"); - $this->add_setting('base_dn', "DC=mydomain,DC=org"); - $this->add_setting('domain_controllers', array("dc01.mydomain.local") ); - $this->add_setting('directory', "ad"); - $this->add_setting('role', "contributor"); - $this->add_setting('high_security', "true"); - $this->add_setting('ol_login', "uid"); - $this->add_setting('ol_group', "cn"); - $this->add_setting('use_tls', "false"); - $this->add_setting('ldap_port', 389); - $this->add_setting('ldap_version', 3); - $this->add_setting('create_users', "false"); - $this->add_setting('enabled', "false"); - $this->add_setting('search_sub_ous', "false"); - $this->add_setting('group_dn', ""); - $this->add_setting('group_uid', "memberUid"); - - // User attribute settings - $this->add_setting('user_first_name_attribute', "givenname"); - $this->add_setting('user_last_name_attribute', "sn"); - $this->add_setting('user_email_attribute', "mail"); - $this->add_setting('user_url_attribute', "wwwhomepage"); - $this->add_setting('user_meta_data', array() ); - } - - function upgrade_settings() { - if( $this->get_setting('version') === false ) { - $this->set_setting('enabled', 'true'); - - if ($this->is_network_version()) { - $account_suffix = get_site_option('simpleldap_account_suffix'); - $simpleldap_base_dn = get_site_option('simpleldap_base_dn'); - $simpleldap_domain_controllers = get_site_option('simpleldap_domain_controllers'); - $simpleldap_directory_type = get_site_option('simpleldap_directory_type'); - $simpleldap_group = get_site_option('simpleldap_group'); - $simpleldap_account_type = get_site_option('simpleldap_account_type'); - $simpleldap_ol_login = get_site_option('simpleldap_ol_login'); - $simpleldap_use_tls = get_site_option('simpleldap_use_tls'); - $simpleldap_login_mode = get_site_option('simpleldap_login_mode'); - $simpleldap_security_mode = get_site_option('simpleldap_security_mode'); - } - else { - $account_suffix = get_option('simpleldap_account_suffix'); - $simpleldap_base_dn = get_option('simpleldap_base_dn'); - $simpleldap_domain_controllers = get_option('simpleldap_domain_controllers'); - $simpleldap_directory_type = get_option('simpleldap_directory_type'); - $simpleldap_group = get_option('simpleldap_group'); - $simpleldap_account_type = get_option('simpleldap_account_type'); - $simpleldap_ol_login = get_option('simpleldap_ol_login'); - $simpleldap_use_tls = get_option('simpleldap_use_tls'); - $simpleldap_login_mode = get_option('simpleldap_login_mode'); - $simpleldap_security_mode = get_option('simpleldap_security_mode'); - } - - $this->set_setting('account_suffix', $account_suffix ); - $this->set_setting('base_dn', $simpleldap_base_dn); - $this->set_setting('domain_controllers', $simpleldap_domain_controllers); - $this->set_setting('groups', (array)$simpleldap_group ); - $this->set_setting('role', $simpleldap_account_type); - $this->set_setting('ol_login', $simpleldap_ol_login); - $this->set_setting('use_tls', str_true( $simpleldap_use_tls ) ); - - // Directory Type - if ( $simpleldap_directory_type == "directory_ad" ) { - $this->set_setting('directory', 'ad'); - } else { - $this->set_setting('directory', 'ol'); - } - - // Create User Setting - $create_users = false; - if ( $simpleldap_login_mode == "mode_create_all" || $simpleldap_login_mode == "mode_create_group" ) { - $this->set_setting('create_users', true); - } - - // High Security Setting - $high_security = false; - if ( $simpleldap_security_mode == "security_high" ) { - $this->set_setting('high_security', true); - } - } - - if ( $this->get_setting('version') < $this->version || $this->get_setting('version') === false ) { - $this->add_setting('search_sub_ous', "false"); - $this->add_setting('group_base_dn', ""); - $this->add_setting('group_uid', "memberUid"); - - // User attribute settings - $this->add_setting('user_first_name_attribute', "givenname"); - $this->add_setting('user_last_name_attribute', "sn"); - $this->add_setting('user_email_attribute', "mail"); - $this->add_setting('user_url_attribute', "wwwhomepage"); - $this->add_setting('user_meta_data', array() ); - } - - // Update version - $this->set_setting( 'version', $this->version ); - } - - function menu () { - if ($this->is_network_version()) { - add_submenu_page( - "settings.php", - "Simple LDAP Login", - "Simple LDAP Login", - 'manage_network_plugins', - "simple-ldap-login", - array($this, 'admin_page') - ); - } - else { - add_options_page("Simple LDAP Login", "Simple LDAP Login", 'manage_options', "simple-ldap-login", array($this, 'admin_page') ); - } - } - - function admin_page () { - include 'Simple-LDAP-Login-Admin.php'; - } - - function get_settings_obj () { - if ( $this->is_network_version() ) { - return get_site_option("{$this->prefix}settings", false); - } - else { - return get_option("{$this->prefix}settings", false); - } - } - - function set_settings_obj ( $newobj ) { - if ( $this->is_network_version() ) { - return update_site_option("{$this->prefix}settings", $newobj); - } - else { - return update_option("{$this->prefix}settings", $newobj); - } - - } - - function set_setting ( $option = false, $newvalue ) { - if( $option === false ) return false; - - $this->settings = $this->get_settings_obj($this->prefix); - $this->settings[$option] = $newvalue; - return $this->set_settings_obj($this->settings); - } - - function get_setting ( $option = false ) { - if( $option === false || ! isset($this->settings[$option]) ) return false; - - return apply_filters($this->prefix . 'get_setting', $this->settings[$option], $option); - } - - function add_setting ( $option = false, $newvalue ) { - if( $option === false ) return false; - - if ( ! isset($this->settings[$option]) ) { - return $this->set_setting($option, $newvalue); - } else return false; - } - - function get_field_name($setting, $type = 'string') { - return "{$this->prefix}setting[$setting][$type]"; - } - - function save_settings() - { - if( isset($_REQUEST["{$this->prefix}setting"]) && check_admin_referer('save_sll_settings','save_the_sll') ) { - $new_settings = $_REQUEST["{$this->prefix}setting"]; - - foreach( $new_settings as $setting_name => $setting_value ) { - foreach( $setting_value as $type => $value ) { - if( $setting_name == 'user_meta_data') { - $this->set_setting($setting_name, - array_map( function ($attr) { return explode(':', $attr); }, - array_filter(preg_split('/\r\n|\n|\r|;/', $value)))); - } - elseif( $type == "array") { - $this->set_setting($setting_name, explode(";", $value)); - } else { - $this->set_setting($setting_name, $value); - } - } - } - - add_action('admin_notices', array($this, 'saved_admin_notice') ); - } - } - - function saved_admin_notice(){ - echo '
-

Simple LDAP Login settings have been saved.

-
'; - - if( ! str_true($this->get_setting('enabled')) ) { - echo '
-

Simple LDAP Login is disabled.

-
'; - } - } - - function authenticate ($user, $username, $password) { - // If previous authentication succeeded, respect that - if ( is_a($user, 'WP_User') ) { return $user; } - - // Determine if user a local admin - $local_admin = false; - $user_obj = get_user_by('login', $username); - if( user_can($user_obj, 'update_core') ) $local_admin = true; - - $local_admin = apply_filters( 'sll_force_ldap', $local_admin ); - $password = stripslashes($password); - - // To force LDAP authentication, the filter should return boolean false - - if ( empty($username) || empty($password) ) { - $error = new WP_Error(); - - if ( empty($username) ) - $error->add('empty_username', __('ERROR: The username field is empty.')); - - if ( empty($password) ) - $error->add('empty_password', __('ERROR: The password field is empty.')); - - return $error; - } - - // If high security mode is enabled, remove default WP authentication hook - if ( apply_filters('sll_remove_default_authentication_hook', str_true( $this->get_setting('high_security') ) && ! $local_admin ) ) { - remove_filter('authenticate', 'wp_authenticate_username_password', 20, 3); - } - - // Sweet, let's try to authenticate our user and pass against LDAP - $auth_result = $this->ldap_auth($username, $password, $this->get_setting('directory') ); - - if( $auth_result ) { - // Authenticated, does user have required groups, if any? - if( $this->user_has_groups( $username, $this->get_setting('directory') ) ) { - - $user = get_user_by('login', $username); - - if ( ! $user || ( strtolower($user->user_login) !== strtolower($username) ) ) { - if( ! str_true($this->get_setting('create_users')) ) { - do_action( 'wp_login_failed', $username ); - return $this->ldap_auth_error('invalid_username', __('Simple LDAP Login Error: LDAP credentials are correct, but there is no matching WordPress user and user creation is not enabled.')); - } - - $new_user = wp_insert_user( $this->get_user_data( $username, $this->get_setting('directory') ) ); - - if( ! is_wp_error($new_user) ) - { - // Add user meta data - $user_meta_data = $this->get_user_meta_data( $username, $this->get_setting('directory')); - foreach( $user_meta_data as $meta_key => $meta_value ) { - add_user_meta($new_user, $meta_key, $meta_value); - } - - // Successful Login - $new_user = new WP_User($new_user); - do_action_ref_array($this->prefix . 'auth_success', array($new_user) ); - - return $new_user; - } - else - { - do_action( 'wp_login_failed', $username ); - return $this->ldap_auth_error("{$this->prefix}login_error", __('Simple LDAP Login Error: LDAP credentials are correct and user creation is allowed but an error occurred creating the user in WordPress. Actual error: '.$new_user->get_error_message() )); - } - - } else { - return new WP_User($user->ID); - } - } else { - return $this->ldap_auth_error("{$this->prefix}login_error", __('Simple LDAP Login Error: Your LDAP credentials are correct, but you are not in an authorized LDAP group.')); - } - - } elseif ( str_true($this->get_setting('high_security')) ) { - return $this->ldap_auth_error('invalid_username', __('Simple LDAP Login: Simple LDAP Login could not authenticate your credentials. The security settings do not permit trying the WordPress user database as a fallback.')); - } - - do_action($this->prefix . 'auth_failure'); - return false; - } - - function get_domain_username( $username ) { - // Format username with domain prefix, if login_domain is set - $login_domain = $this->get_setting('login_domain'); - - if ( ! empty($login_domain) ) { - return $login_domain . '\\' . $username; - } - - return $username; - } - - function ldap_auth( $username, $password, $directory ) { - $result = false; - - if ( $directory == "ad" ) { - $result = $this->adldap->authenticate( $this->get_domain_username($username), $password ); - } elseif ( $directory == "ol" ) { - $this->ldap = ldap_connect( join(' ', (array)$this->get_setting('domain_controllers')), (int)$this->get_setting('ldap_port') ); - ldap_set_option($this->ldap, LDAP_OPT_PROTOCOL_VERSION, (int)$this->get_setting('ldap_version')); - if ( str_true($this->get_setting('use_tls')) ) { - ldap_start_tls($this->ldap); - } - $dn = $this->get_setting('ol_login') .'=' . $username . ',' . $this->get_setting('base_dn'); - if (str_true($this->get_setting('search_sub_ous'))) { - // search for user's DN in the base DN and below - $filter = $this->get_setting('ol_login') .'=' . $username; - $sr = @ldap_search($this->ldap, $this->get_setting('base_dn'), $filter, array('cn')); - if ($sr !== FALSE) { - $info = @ldap_get_entries($this->ldap, $sr); - if ($info !== FALSE && $info['count'] > 0) { - $dn = $info[0]['dn']; - } - } - } - $ldapbind = @ldap_bind($this->ldap, $dn, $password); - $this->dn = $dn; - $result = $ldapbind; - } - - return apply_filters($this->prefix . 'ldap_auth', $result); - } - - /** - * Prevent modification of the error message by other authenticate hooks - * before it is shown to the user - * - * @param string $code - * @param string $message - * @return WP_Error - */ - function ldap_auth_error( $code, $message ) { - remove_all_filters( 'authenticate' ); - return new WP_Error( $code, $message ); - } - - function user_has_groups( $username = false, $directory ) { - $result = false; - $groups = (array)$this->get_setting('groups'); - $groups = array_filter($groups); - - if ( ! $username ) return $result; - if ( count( $groups ) == 0 ) return true; - - if ( $directory == "ad" ) { - foreach ($groups as $gp) { - if ( $this->adldap->user_ingroup ($username, $gp ) ) { - $result = true; - break; - } - } - } elseif ( $directory == "ol" ) { - if( $this->ldap === false ) return false; - - $group_base_dn = $this->get_setting('group_base_dn') !== false ? $this->get_setting('group_base_dn') : $this->get_setting('base_dn'); - $result = ldap_search($this->ldap, $group_base_dn, '(|(&(objectClass=groupOfUniqueNames)(uniquemember=' . $this->dn . '))(&(objectClass=groupOfNames)(member=' . $this->dn . '))(' . $this->get_setting('group_uid') . '=' . $username . '))', array($this->get_setting('ol_group'))); - $ldapgroups = ldap_get_entries($this->ldap, $result); - - // Ok, we should have the user, all the info, including which groups he is a member of. - // Let's make sure he's in the right group before proceeding. - $user_groups = array(); - for ( $i = 0; $i < $ldapgroups['count']; $i++) { - $user_groups[] = $ldapgroups[$i][$this->get_setting('ol_group')][0]; - } - - $result = (bool)(count( array_intersect($user_groups, $groups) ) > 0); - } - - return apply_filters($this->prefix . 'user_has_groups', $result); - } - - function get_user_data( $username, $directory ) { - $user_data = array( - 'user_pass' => md5( microtime() ), - 'user_login' => $username, - 'user_nicename' => '', - 'user_email' => '', - 'display_name' => '', - 'first_name' => '', - 'last_name' => '', - 'user_url' => '', - 'role' => $this->get_setting('role') - ); - - if ( $directory == "ad" ) { - $userinfo = $this->adldap->user_info($username, array("samaccountname","givenname","sn","mail")); - $userinfo = $userinfo[0]; - } elseif ( $directory == "ol" ) { - if ( $this->ldap == null ) {return false;} - - $attributes = array( - $this->get_setting('ol_login'), - $this->get_setting('user_last_name_attribute'), - $this->get_setting('user_first_name_attribute'), - $this->get_setting('user_email_attribute'), - $this->get_setting('user_url_attribute') - ); - - $result = ldap_search($this->ldap, $this->get_setting('base_dn'), '(' . $this->get_setting('ol_login') . '=' . $username . ')', $attributes); - $userinfo = ldap_get_entries($this->ldap, $result); - - if ($userinfo['count'] == 1) { - $userinfo = $userinfo[0]; - } - } else return false; - - if( is_array($userinfo) ) { - $user_data['user_nicename'] = strtolower($userinfo[$this->get_setting('user_first_name_attribute')][0]) . '-' . strtolower($userinfo[$this->get_setting('user_last_name_attribute')][0]); - $user_data['user_email'] = $userinfo[$this->get_setting('user_email_attribute')][0]; - $user_data['display_name'] = $userinfo[$this->get_setting('user_first_name_attribute')][0] . ' ' . $userinfo[$this->get_setting('user_last_name_attribute')][0]; - $user_data['first_name'] = $userinfo[$this->get_setting('user_first_name_attribute')][0]; - $user_data['last_name'] = $userinfo[$this->get_setting('user_last_name_attribute')][0]; - $user_data['user_url'] = $userinfo[$this->get_setting('user_url_attribute')][0]; - } - - return apply_filters($this->prefix . 'user_data', $user_data); - } - - function get_user_meta_data( $username, $directory ) { - if ( $directory == "ad" ) { - // TODO: get user meta data for ad - return false; - } elseif ( $directory == "ol" ) { - if ( $this->ldap == null ) {return false;} - - $attributes = array(); - foreach( $this->get_setting('user_meta_data') as $attr ) { - $attributes[] = $attr[0]; - } - $result = ldap_search($this->ldap, $this->get_setting('base_dn'), '(' . $this->get_setting('ol_login') . '=' . $username . ')', $attributes); - $userinfo = ldap_get_entries($this->ldap, $result); - - if ($userinfo['count'] == 1) { - $userinfo = $userinfo[0]; - } - } else return false; - - $user_meta_data = array(); - foreach( $this->get_setting('user_meta_data') as $attr ) { - $user_meta_data[$attr[1]] = $userinfo[$attr[0]][0]; - } - - return apply_filters($this->prefix . 'user_meta_data', $user_meta_data); - } - - /** - * Returns whether this plugin is currently network activated - */ - function is_network_version() { - if ( $this->network_version !== null) { - return $this->network_version; - } - - if ( ! function_exists( 'is_plugin_active_for_network' ) ) { - require_once( ABSPATH . '/wp-admin/includes/plugin.php' ); - } - - if ( is_plugin_active_for_network( plugin_basename(__FILE__) ) ) { - $this->network_version = true; - } - else { - $this->network_version = false; - - } - return $this->network_version; - } -} - -if ( ! function_exists('str_true') ) { - /** - * Evaluates natural language strings to boolean equivalent - * - * Used primarily for handling boolean text provided in shopp() tag options. - * All values defined as true will return true, anything else is false. - * - * Boolean values will be passed through. - * - * Replaces the 1.0-1.1 value_is_true() - * - * @author Jonathan Davis - * @since 1.2 - * - * @param string $string The natural language value - * @param array $istrue A list strings that are true - * @return boolean The boolean value of the provided text - **/ - function str_true ( $string, $istrue = array('yes', 'y', 'true','1','on','open') ) { - if (is_array($string)) return false; - if (is_bool($string)) return $string; - return in_array(strtolower($string),$istrue); - } -} - -$SimpleLDAPLogin = SimpleLDAPLogin::getInstance(); diff --git a/sources/extra_files/wp-content/plugins/simple-ldap-login/includes/adLDAP.php b/sources/extra_files/wp-content/plugins/simple-ldap-login/includes/adLDAP.php deleted file mode 100644 index 1485a0f..0000000 --- a/sources/extra_files/wp-content/plugins/simple-ldap-login/includes/adLDAP.php +++ /dev/null @@ -1,2413 +0,0 @@ -_account_suffix = $_account_suffix; - } - - /** - * Get the account suffix - * - * @return string - */ - public function get_account_suffix() - { - return $this->_account_suffix; - } - - /** - * Set the domain controllers array - * - * @param array $_domain_controllers - * @return void - */ - public function set_domain_controllers(array $_domain_controllers) - { - $this->_domain_controllers = $_domain_controllers; - } - - /** - * Get the list of domain controllers - * - * @return void - */ - public function get_domain_controllers() - { - return $this->_domain_controllers; - } - - /** - * Set the username of an account with higher priviledges - * - * @param string $_ad_username - * @return void - */ - public function set_ad_username($_ad_username) - { - $this->_ad_username = $_ad_username; - } - - /** - * Get the username of the account with higher priviledges - * - * This will throw an exception for security reasons - */ - public function get_ad_username() - { - throw new adLDAPException('For security reasons you cannot access the domain administrator account details'); - } - - /** - * Set the password of an account with higher priviledges - * - * @param string $_ad_password - * @return void - */ - public function set_ad_password($_ad_password) - { - $this->_ad_password = $_ad_password; - } - - /** - * Get the password of the account with higher priviledges - * - * This will throw an exception for security reasons - */ - public function get_ad_password() - { - throw new adLDAPException('For security reasons you cannot access the domain administrator account details'); - } - - /** - * Set whether to detect the true primary group - * - * @param bool $_real_primary_group - * @return void - */ - public function set_real_primarygroup($_real_primarygroup) - { - $this->_real_primarygroup = $_real_primarygroup; - } - - /** - * Get the real primary group setting - * - * @return bool - */ - public function get_real_primarygroup() - { - return $this->_real_primarygroup; - } - - /** - * Set whether to use SSL - * - * @param bool $_use_ssl - * @return void - */ - public function set_use_ssl($_use_ssl) - { - $this->_use_ssl = $_use_ssl; - } - - /** - * Get the SSL setting - * - * @return bool - */ - public function get_use_ssl() - { - return $this->_use_ssl; - } - - /** - * Set whether to use TLS - * - * @param bool $_use_tls - * @return void - */ - public function set_use_tls($_use_tls) - { - $this->_use_tls = $_use_tls; - } - - /** - * Get the TLS setting - * - * @return bool - */ - public function get_use_tls() - { - return $this->_use_tls; - } - - /** - * Set whether to lookup recursive groups - * - * @param bool $_recursive_groups - * @return void - */ - public function set_recursive_groups($_recursive_groups) - { - $this->_recursive_groups = $_recursive_groups; - } - - /** - * Get the recursive groups setting - * - * @return bool - */ - public function get_recursive_groups() - { - return $this->_recursive_groups; - } - - /** - * Default Constructor - * - * Tries to bind to the AD domain over LDAP or LDAPs - * - * @param array $options Array of options to pass to the constructor - * @throws Exception - if unable to bind to Domain Controller - * @return bool - */ - function __construct($options=array()){ - // You can specifically overide any of the default configuration options setup above - if (count($options)>0){ - if (array_key_exists("account_suffix",$options)){ $this->_account_suffix=$options["account_suffix"]; } - if (array_key_exists("base_dn",$options)){ $this->_base_dn=$options["base_dn"]; } - if (array_key_exists("domain_controllers",$options)){ $this->_domain_controllers=$options["domain_controllers"]; } - if (array_key_exists("ad_username",$options)){ $this->_ad_username=$options["ad_username"]; } - if (array_key_exists("ad_password",$options)){ $this->_ad_password=$options["ad_password"]; } - if (array_key_exists("real_primarygroup",$options)){ $this->_real_primarygroup=$options["real_primarygroup"]; } - if (array_key_exists("use_ssl",$options)){ $this->_use_ssl=$options["use_ssl"]; } - if (array_key_exists("use_tls",$options)){ $this->_use_tls=$options["use_tls"]; } - if (array_key_exists("recursive_groups",$options)){ $this->_recursive_groups=$options["recursive_groups"]; } - } - - if ($this->ldap_supported() === false) { - throw new adLDAPException('No LDAP support for PHP. See: http://www.php.net/ldap'); - } - - return $this->connect(); - } - - /** - * Default Destructor - * - * Closes the LDAP connection - * - * @return void - */ - function __destruct(){ $this->close(); } - - /** - * Connects and Binds to the Domain Controller - * - * @return bool - */ - public function connect() { - // Connect to the AD/LDAP server as the username/password - $dc=$this->random_controller(); - if ($this->_use_ssl){ - $this->_conn = ldap_connect("ldaps://".$dc, 636); - } else { - $this->_conn = ldap_connect($dc); - } - - // Set some ldap options for talking to AD - ldap_set_option($this->_conn, LDAP_OPT_PROTOCOL_VERSION, 3); - ldap_set_option($this->_conn, LDAP_OPT_REFERRALS, 0); - - if ($this->_use_tls) { - ldap_start_tls($this->_conn); - } - - // Bind as a domain admin if they've set it up - if ($this->_ad_username!=NULL && $this->_ad_password!=NULL){ - $this->_bind = @ldap_bind($this->_conn,$this->_ad_username.$this->_account_suffix,$this->_ad_password); - if (!$this->_bind){ - if ($this->_use_ssl && !$this->_use_tls){ - // If you have problems troubleshooting, remove the @ character from the ldap_bind command above to get the actual error message - throw new adLDAPException('Bind to Active Directory failed. Either the LDAPs connection failed or the login credentials are incorrect. AD said: ' . $this->get_last_error()); - } else { - throw new adLDAPException('Bind to Active Directory failed. Check the login credentials and/or server details. AD said: ' . $this->get_last_error()); - } - } - } - - if ($this->_base_dn == NULL) { - $this->_base_dn = $this->find_base_dn(); - } - - return (true); - } - - /** - * Closes the LDAP connection - * - * @return void - */ - public function close() { - ldap_close ($this->_conn); - } - - /** - * Validate a user's login credentials - * - * @param string $username A user's AD username - * @param string $password A user's AD password - * @param bool optional $prevent_rebind - * @return bool - */ - public function authenticate($username, $password, $prevent_rebind = false) { - // Prevent null binding - if ($username === NULL || $password === NULL) { return false; } - if (empty($username) || empty($password)) { return false; } - - // Bind as the user - $ret = true; - $this->_bind = @ldap_bind($this->_conn, $username . $this->_account_suffix, $password); - if (!$this->_bind){ $ret = false; } - - // Cnce we've checked their details, kick back into admin mode if we have it - if ($this->_ad_username !== NULL && !$prevent_rebind) { - $this->_bind = @ldap_bind($this->_conn, $this->_ad_username . $this->_account_suffix , $this->_ad_password); - if (!$this->_bind){ - // This should never happen in theory - throw new adLDAPException('Rebind to Active Directory failed. AD said: ' . $this->get_last_error()); - } - } - - return $ret; - } - - //***************************************************************************************************************** - // GROUP FUNCTIONS - - /** - * Add a group to a group - * - * @param string $parent The parent group name - * @param string $child The child group name - * @return bool - */ - public function group_add_group($parent,$child){ - - // Find the parent group's dn - $parent_group=$this->group_info($parent,array("cn")); - if ($parent_group[0]["dn"]===NULL){ return (false); } - $parent_dn=$parent_group[0]["dn"]; - - // Find the child group's dn - $child_group=$this->group_info($child,array("cn")); - if ($child_group[0]["dn"]===NULL){ return (false); } - $child_dn=$child_group[0]["dn"]; - - $add=array(); - $add["member"] = $child_dn; - - $result=@ldap_mod_add($this->_conn,$parent_dn,$add); - if ($result==false){ return (false); } - return (true); - } - - /** - * Add a user to a group - * - * @param string $group The group to add the user to - * @param string $user The user to add to the group - * @param bool $isGUID Is the username passed a GUID or a samAccountName - * @return bool - */ - public function group_add_user($group,$user,$isGUID=false){ - // Adding a user is a bit fiddly, we need to get the full DN of the user - // and add it using the full DN of the group - - // Find the user's dn - $user_dn=$this->user_dn($user,$isGUID); - if ($user_dn===false){ return (false); } - - // Find the group's dn - $group_info=$this->group_info($group,array("cn")); - if ($group_info[0]["dn"]===NULL){ return (false); } - $group_dn=$group_info[0]["dn"]; - - $add=array(); - $add["member"] = $user_dn; - - $result=@ldap_mod_add($this->_conn,$group_dn,$add); - if ($result==false){ return (false); } - return (true); - } - - /** - * Add a contact to a group - * - * @param string $group The group to add the contact to - * @param string $contact_dn The DN of the contact to add - * @return bool - */ - public function group_add_contact($group,$contact_dn){ - // To add a contact we take the contact's DN - // and add it using the full DN of the group - - // Find the group's dn - $group_info=$this->group_info($group,array("cn")); - if ($group_info[0]["dn"]===NULL){ return (false); } - $group_dn=$group_info[0]["dn"]; - - $add=array(); - $add["member"] = $contact_dn; - - $result=@ldap_mod_add($this->_conn,$group_dn,$add); - if ($result==false){ return (false); } - return (true); - } - - /** - * Create a group - * - * @param array $attributes Default attributes of the group - * @return bool - */ - public function group_create($attributes){ - if (!is_array($attributes)){ return ("Attributes must be an array"); } - if (!array_key_exists("group_name",$attributes)){ return ("Missing compulsory field [group_name]"); } - if (!array_key_exists("container",$attributes)){ return ("Missing compulsory field [container]"); } - if (!array_key_exists("description",$attributes)){ return ("Missing compulsory field [description]"); } - if (!is_array($attributes["container"])){ return ("Container attribute must be an array."); } - $attributes["container"]=array_reverse($attributes["container"]); - - //$member_array = array(); - //$member_array[0] = "cn=user1,cn=Users,dc=yourdomain,dc=com"; - //$member_array[1] = "cn=administrator,cn=Users,dc=yourdomain,dc=com"; - - $add=array(); - $add["cn"] = $attributes["group_name"]; - $add["samaccountname"] = $attributes["group_name"]; - $add["objectClass"] = "Group"; - $add["description"] = $attributes["description"]; - //$add["member"] = $member_array; UNTESTED - - $container="OU=".implode(",OU=",$attributes["container"]); - $result=ldap_add($this->_conn,"CN=".$add["cn"].", ".$container.",".$this->_base_dn,$add); - if ($result!=true){ return (false); } - - return (true); - } - - /** - * Remove a group from a group - * - * @param string $parent The parent group name - * @param string $child The child group name - * @return bool - */ - public function group_del_group($parent,$child){ - - // Find the parent dn - $parent_group=$this->group_info($parent,array("cn")); - if ($parent_group[0]["dn"]===NULL){ return (false); } - $parent_dn=$parent_group[0]["dn"]; - - // Find the child dn - $child_group=$this->group_info($child,array("cn")); - if ($child_group[0]["dn"]===NULL){ return (false); } - $child_dn=$child_group[0]["dn"]; - - $del=array(); - $del["member"] = $child_dn; - - $result=@ldap_mod_del($this->_conn,$parent_dn,$del); - if ($result==false){ return (false); } - return (true); - } - - /** - * Remove a user from a group - * - * @param string $group The group to remove a user from - * @param string $user The AD user to remove from the group - * @param bool $isGUID Is the username passed a GUID or a samAccountName - * @return bool - */ - public function group_del_user($group,$user,$isGUID=false){ - - // Find the parent dn - $group_info=$this->group_info($group,array("cn")); - if ($group_info[0]["dn"]===NULL){ return (false); } - $group_dn=$group_info[0]["dn"]; - - // Find the users dn - $user_dn=$this->user_dn($user,$isGUID); - if ($user_dn===false){ return (false); } - - $del=array(); - $del["member"] = $user_dn; - - $result=@ldap_mod_del($this->_conn,$group_dn,$del); - if ($result==false){ return (false); } - return (true); - } - - /** - * Remove a contact from a group - * - * @param string $group The group to remove a user from - * @param string $contact_dn The DN of a contact to remove from the group - * @return bool - */ - public function group_del_contact($group,$contact_dn){ - - // Find the parent dn - $group_info=$this->group_info($group,array("cn")); - if ($group_info[0]["dn"]===NULL){ return (false); } - $group_dn=$group_info[0]["dn"]; - - $del=array(); - $del["member"] = $contact_dn; - - $result=@ldap_mod_del($this->_conn,$group_dn,$del); - if ($result==false){ return (false); } - return (true); - } - - /** - * Return a list of groups in a group - * - * @param string $group The group to query - * @param bool $recursive Recursively get groups - * @return array - */ - public function groups_in_group($group, $recursive = NULL){ - if (!$this->_bind){ return (false); } - if ($recursive===NULL){ $recursive=$this->_recursive_groups; } // Use the default option if they haven't set it - - // Search the directory for the members of a group - $info=$this->group_info($group,array("member","cn")); - $groups=$info[0]["member"]; - if (!is_array($groups)) { - return (false); - } - - $group_array=array(); - - for ($i=0; $i<$groups["count"]; $i++){ - $filter="(&(objectCategory=group)(distinguishedName=".$this->ldap_slashes($groups[$i])."))"; - $fields = array("samaccountname", "distinguishedname", "objectClass"); - $sr=ldap_search($this->_conn,$this->_base_dn,$filter,$fields); - $entries = ldap_get_entries($this->_conn, $sr); - - // not a person, look for a group - if ($entries['count'] == 0 && $recursive == true) { - $filter="(&(objectCategory=group)(distinguishedName=".$this->ldap_slashes($groups[$i])."))"; - $fields = array("distinguishedname"); - $sr=ldap_search($this->_conn,$this->_base_dn,$filter,$fields); - $entries = ldap_get_entries($this->_conn, $sr); - if (!isset($entries[0]['distinguishedname'][0])) { - continue; - } - $sub_groups = $this->groups_in_group($entries[0]['distinguishedname'][0], $recursive); - if (is_array($sub_groups)) { - $group_array = array_merge($group_array, $sub_groups); - $group_array = array_unique($group_array); - } - continue; - } - - $group_array[] = $entries[0]['distinguishedname'][0]; - } - return ($group_array); - } - - /** - * Return a list of members in a group - * - * @param string $group The group to query - * @param bool $recursive Recursively get group members - * @return array - */ - public function group_members($group, $recursive = NULL){ - if (!$this->_bind){ return (false); } - if ($recursive===NULL){ $recursive=$this->_recursive_groups; } // Use the default option if they haven't set it - // Search the directory for the members of a group - $info=$this->group_info($group,array("member","cn")); - $users=$info[0]["member"]; - if (!is_array($users)) { - return (false); - } - - $user_array=array(); - - for ($i=0; $i<$users["count"]; $i++){ - $filter="(&(objectCategory=person)(distinguishedName=".$this->ldap_slashes($users[$i])."))"; - $fields = array("samaccountname", "distinguishedname", "objectClass"); - $sr=ldap_search($this->_conn,$this->_base_dn,$filter,$fields); - $entries = ldap_get_entries($this->_conn, $sr); - - // not a person, look for a group - if ($entries['count'] == 0 && $recursive == true) { - $filter="(&(objectCategory=group)(distinguishedName=".$this->ldap_slashes($users[$i])."))"; - $fields = array("samaccountname"); - $sr=ldap_search($this->_conn,$this->_base_dn,$filter,$fields); - $entries = ldap_get_entries($this->_conn, $sr); - if (!isset($entries[0]['samaccountname'][0])) { - continue; - } - $sub_users = $this->group_members($entries[0]['samaccountname'][0], $recursive); - if (is_array($sub_users)) { - $user_array = array_merge($user_array, $sub_users); - $user_array = array_unique($user_array); - } - continue; - } - - if ($entries[0]['samaccountname'][0] === NULL && $entries[0]['distinguishedname'][0] !== NULL) { - $user_array[] = $entries[0]['distinguishedname'][0]; - } - elseif ($entries[0]['samaccountname'][0] !== NULL) { - $user_array[] = $entries[0]['samaccountname'][0]; - } - } - return ($user_array); - } - - /** - * Group Information. Returns an array of information about a group. - * The group name is case sensitive - * - * @param string $group_name The group name to retrieve info about - * @param array $fields Fields to retrieve - * @return array - */ - public function group_info($group_name,$fields=NULL){ - if ($group_name===NULL){ return (false); } - if (!$this->_bind){ return (false); } - - if (stristr($group_name, '+')) { - $group_name=stripslashes($group_name); - } - - $filter="(&(objectCategory=group)(name=".$this->ldap_slashes($group_name)."))"; - //echo ($filter."!!!
"); - if ($fields===NULL){ $fields=array("member","memberof","cn","description","distinguishedname","objectcategory","samaccountname"); } - $sr=ldap_search($this->_conn,$this->_base_dn,$filter,$fields); - $entries = ldap_get_entries($this->_conn, $sr); - //print_r($entries); - return ($entries); - } - - /** - * Return a complete list of "groups in groups" - * - * @param string $group The group to get the list from - * @return array - */ - public function recursive_groups($group){ - if ($group===NULL){ return (false); } - - $ret_groups=array(); - - $groups=$this->group_info($group,array("memberof")); - if (isset($groups[0]["memberof"]) && is_array($groups[0]["memberof"])) { - $groups=$groups[0]["memberof"]; - - if ($groups){ - $group_names=$this->nice_names($groups); - $ret_groups=array_merge($ret_groups,$group_names); //final groups to return - - foreach ($group_names as $id => $group_name){ - $child_groups=$this->recursive_groups($group_name); - $ret_groups=array_merge($ret_groups,$child_groups); - } - } - } - - return ($ret_groups); - } - - /** - * Returns a complete list of the groups in AD based on a SAM Account Type - * - * @param string $samaccounttype The account type to return - * @param bool $include_desc Whether to return a description - * @param string $search Search parameters - * @param bool $sorted Whether to sort the results - * @return array - */ - public function search_groups($samaccounttype = ADLDAP_SECURITY_GLOBAL_GROUP, $include_desc = false, $search = "*", $sorted = true) { - if (!$this->_bind){ return (false); } - - $filter = '(&(objectCategory=group)'; - if ($samaccounttype !== null) { - $filter .= '(samaccounttype='. $samaccounttype .')'; - } - $filter .= '(cn='.$search.'))'; - // Perform the search and grab all their details - $fields=array("samaccountname","description"); - $sr=ldap_search($this->_conn,$this->_base_dn,$filter,$fields); - $entries = ldap_get_entries($this->_conn, $sr); - - $groups_array = array(); - for ($i=0; $i<$entries["count"]; $i++){ - if ($include_desc && strlen($entries[$i]["description"][0]) > 0 ){ - $groups_array[ $entries[$i]["samaccountname"][0] ] = $entries[$i]["description"][0]; - } elseif ($include_desc){ - $groups_array[ $entries[$i]["samaccountname"][0] ] = $entries[$i]["samaccountname"][0]; - } else { - array_push($groups_array, $entries[$i]["samaccountname"][0]); - } - } - if( $sorted ){ asort($groups_array); } - return ($groups_array); - } - - /** - * Returns a complete list of all groups in AD - * - * @param bool $include_desc Whether to return a description - * @param string $search Search parameters - * @param bool $sorted Whether to sort the results - * @return array - */ - public function all_groups($include_desc = false, $search = "*", $sorted = true){ - $groups_array = $this->search_groups(null, $include_desc, $search, $sorted); - return ($groups_array); - } - - /** - * Returns a complete list of security groups in AD - * - * @param bool $include_desc Whether to return a description - * @param string $search Search parameters - * @param bool $sorted Whether to sort the results - * @return array - */ - public function all_security_groups($include_desc = false, $search = "*", $sorted = true){ - $groups_array = $this->search_groups(ADLDAP_SECURITY_GLOBAL_GROUP, $include_desc, $search, $sorted); - return ($groups_array); - } - - /** - * Returns a complete list of distribution lists in AD - * - * @param bool $include_desc Whether to return a description - * @param string $search Search parameters - * @param bool $sorted Whether to sort the results - * @return array - */ - public function all_distribution_groups($include_desc = false, $search = "*", $sorted = true){ - $groups_array = $this->search_groups(ADLDAP_DISTRIBUTION_GROUP, $include_desc, $search, $sorted); - return ($groups_array); - } - - //***************************************************************************************************************** - // USER FUNCTIONS - - /** - * Create a user - * - * If you specify a password here, this can only be performed over SSL - * - * @param array $attributes The attributes to set to the user account - * @return bool - */ - public function user_create($attributes){ - // Check for compulsory fields - if (!array_key_exists("username",$attributes)){ return ("Missing compulsory field [username]"); } - if (!array_key_exists("firstname",$attributes)){ return ("Missing compulsory field [firstname]"); } - if (!array_key_exists("surname",$attributes)){ return ("Missing compulsory field [surname]"); } - if (!array_key_exists("email",$attributes)){ return ("Missing compulsory field [email]"); } - if (!array_key_exists("container",$attributes)){ return ("Missing compulsory field [container]"); } - if (!is_array($attributes["container"])){ return ("Container attribute must be an array."); } - - if (array_key_exists("password",$attributes) && (!$this->_use_ssl && !$this->_use_tls)){ - throw new adLDAPException('SSL must be configured on your webserver and enabled in the class to set passwords.'); - } - - if (!array_key_exists("display_name",$attributes)){ $attributes["display_name"]=$attributes["firstname"]." ".$attributes["surname"]; } - - // Translate the schema - $add=$this->adldap_schema($attributes); - - // Additional stuff only used for adding accounts - $add["cn"][0]=$attributes["display_name"]; - $add["samaccountname"][0]=$attributes["username"]; - $add["objectclass"][0]="top"; - $add["objectclass"][1]="person"; - $add["objectclass"][2]="organizationalPerson"; - $add["objectclass"][3]="user"; //person? - //$add["name"][0]=$attributes["firstname"]." ".$attributes["surname"]; - - // Set the account control attribute - $control_options=array("NORMAL_ACCOUNT"); - if (!$attributes["enabled"]){ $control_options[]="ACCOUNTDISABLE"; } - $add["userAccountControl"][0]=$this->account_control($control_options); - //echo ("
"); print_r($add);
-
-        // Determine the container
-        $attributes["container"]=array_reverse($attributes["container"]);
-        $container="OU=".implode(",OU=",$attributes["container"]);
-
-        // Add the entry
-        $result=@ldap_add($this->_conn, "CN=".$add["cn"][0].", ".$container.",".$this->_base_dn, $add);
-        if ($result!=true){ return (false); }
-        
-        return (true);
-    }
-    
-    /**
-    * Delete a user account
-    * 
-    * @param string $username The username to delete (please be careful here!)
-    * @param bool $isGUID Is the username a GUID or a samAccountName
-    * @return array
-    */
-    public function user_delete($username,$isGUID=false) {      
-        $userinfo = $this->user_info($username, array("*"),$isGUID);
-        $dn = $userinfo[0]['distinguishedname'][0];
-        $result=$this->dn_delete($dn);
-        if ($result!=true){ return (false); }        
-        return (true);
-    }
-    
-    /**
-    * Groups the user is a member of
-    * 
-    * @param string $username The username to query
-    * @param bool $recursive Recursive list of groups
-    * @param bool $isGUID Is the username passed a GUID or a samAccountName
-    * @return array
-    */
-    public function user_groups($username,$recursive=NULL,$isGUID=false){
-        if ($username===NULL){ return (false); }
-        if ($recursive===NULL){ $recursive=$this->_recursive_groups; } // Use the default option if they haven't set it
-        if (!$this->_bind){ return (false); }
-        
-        // Search the directory for their information
-        $info=@$this->user_info($username,array("memberof","primarygroupid"),$isGUID);
-        $groups=$this->nice_names($info[0]["memberof"]); // Presuming the entry returned is our guy (unique usernames)
-
-        if ($recursive === true){
-            foreach ($groups as $id => $group_name){
-                $extra_groups=$this->recursive_groups($group_name);
-                $groups=array_merge($groups,$extra_groups);
-            }
-        }
-        
-        return ($groups);
-    }
-    
-    /**
-    * Find information about the users
-    * 
-    * @param string $username The username to query
-    * @param array $fields Array of parameters to query
-    * @param bool $isGUID Is the username passed a GUID or a samAccountName
-    * @return array
-    */
-    public function user_info($username,$fields=NULL,$isGUID=false){
-        if ($username===NULL){ return (false); }
-        if (!$this->_bind){ return (false); }
-
-        if ($isGUID === true) {
-            $username = $this->strguid2hex($username);
-            $filter="objectguid=".$username;
-        }
-        else if (strstr($username, "@")) {
-             $filter="userPrincipalName=".$username;
-        }
-        else {
-             $filter="samaccountname=".$username;
-        }
-        $filter = "(&(objectCategory=person)({$filter}))";
-        if ($fields===NULL){ $fields=array("samaccountname","mail","memberof","department","displayname","telephonenumber","primarygroupid","objectsid"); }
-        if (!in_array("objectsid",$fields)){
-            $fields[] = "objectsid";
-        }
-        $sr=ldap_search($this->_conn,$this->_base_dn,$filter,$fields);
-        $entries = ldap_get_entries($this->_conn, $sr);
-        
-        if (isset($entries[0])) {
-            if ($entries[0]['count'] >= 1) {
-                if (in_array("memberof", $fields)) {
-                    // AD does not return the primary group in the ldap query, we may need to fudge it
-                    if ($this->_real_primarygroup && isset($entries[0]["primarygroupid"][0]) && isset($entries[0]["objectsid"][0])){
-                        //$entries[0]["memberof"][]=$this->group_cn($entries[0]["primarygroupid"][0]);
-                        $entries[0]["memberof"][]=$this->get_primary_group($entries[0]["primarygroupid"][0], $entries[0]["objectsid"][0]);
-                    } else {
-                        $entries[0]["memberof"][]="CN=Domain Users,CN=Users,".$this->_base_dn;
-                    }
-                    $entries[0]["memberof"]["count"]++;
-                }
-            }
-            return $entries;
-        }
-        return false;
-    }
-    
-    /**
-    * Determine if a user is in a specific group
-    * 
-    * @param string $username The username to query
-    * @param string $group The name of the group to check against
-    * @param bool $recursive Check groups recursively
-    * @param bool $isGUID Is the username passed a GUID or a samAccountName
-    * @return bool
-    */
-    public function user_ingroup($username,$group,$recursive=NULL,$isGUID=false){
-        if ($username===NULL){ return (false); }
-        if ($group===NULL){ return (false); }
-        if (!$this->_bind){ return (false); }
-        if ($recursive===NULL){ $recursive=$this->_recursive_groups; } // Use the default option if they haven't set it
-        
-        // Get a list of the groups
-        $groups=$this->user_groups($username,$recursive,$isGUID);
-        
-        // Return true if the specified group is in the group list
-        if (in_array($group,$groups)){ return (true); }
-
-        return (false);
-    }
-    
-    /**
-    * Determine a user's password expiry date
-    * 
-    * @param string $username The username to query
-    * @param book $isGUID Is the username passed a GUID or a samAccountName
-    * @requires bcmath http://www.php.net/manual/en/book.bc.php
-    * @return array
-    */
-    public function user_password_expiry($username,$isGUID=false) {
-        if ($username===NULL){ return ("Missing compulsory field [username]"); }
-        if (!$this->_bind){ return (false); }
-        if (!function_exists('bcmod')) { return ("Missing function support [bcmod] http://www.php.net/manual/en/book.bc.php"); };
-        
-        $userinfo = $this->user_info($username, array("pwdlastset", "useraccountcontrol"), $isGUID);
-        $pwdlastset = $userinfo[0]['pwdlastset'][0];
-        $status = array();
-        
-        if ($userinfo[0]['useraccountcontrol'][0] == '66048') {
-            // Password does not expire
-            return "Does not expire";
-        }
-        if ($pwdlastset === '0') {
-            // Password has already expired
-            return "Password has expired";
-        }
-        
-         // Password expiry in AD can be calculated from TWO values:
-         //   - User's own pwdLastSet attribute: stores the last time the password was changed
-         //   - Domain's maxPwdAge attribute: how long passwords last in the domain
-         //
-         // Although Microsoft chose to use a different base and unit for time measurements.
-         // This function will convert them to Unix timestamps
-         $sr = ldap_read($this->_conn, $this->_base_dn, 'objectclass=*', array('maxPwdAge'));
-         if (!$sr) {
-             return false;
-         }
-         $info = ldap_get_entries($this->_conn, $sr);
-         $maxpwdage = $info[0]['maxpwdage'][0];
-         
-
-         // See MSDN: http://msdn.microsoft.com/en-us/library/ms974598.aspx
-         //
-         // pwdLastSet contains the number of 100 nanosecond intervals since January 1, 1601 (UTC), 
-         // stored in a 64 bit integer. 
-         //
-         // The number of seconds between this date and Unix epoch is 11644473600.
-         //
-         // maxPwdAge is stored as a large integer that represents the number of 100 nanosecond
-         // intervals from the time the password was set before the password expires.
-         //
-         // We also need to scale this to seconds but also this value is a _negative_ quantity!
-         //
-         // If the low 32 bits of maxPwdAge are equal to 0 passwords do not expire
-         //
-         // Unfortunately the maths involved are too big for PHP integers, so I've had to require
-         // BCMath functions to work with arbitrary precision numbers.
-         if (bcmod($maxpwdage, 4294967296) === '0') {
-            return "Domain does not expire passwords";
-        }
-        
-        // Add maxpwdage and pwdlastset and we get password expiration time in Microsoft's
-        // time units.  Because maxpwd age is negative we need to subtract it.
-        $pwdexpire = bcsub($pwdlastset, $maxpwdage);
-    
-        // Convert MS's time to Unix time
-        $status['expiryts'] = bcsub(bcdiv($pwdexpire, '10000000'), '11644473600');
-        $status['expiryformat'] = date('Y-m-d H:i:s', bcsub(bcdiv($pwdexpire, '10000000'), '11644473600'));
-        
-        return $status;
-    }
-    
-    /**
-    * Modify a user
-    * 
-    * @param string $username The username to query
-    * @param array $attributes The attributes to modify.  Note if you set the enabled attribute you must not specify any other attributes
-    * @param bool $isGUID Is the username passed a GUID or a samAccountName
-    * @return bool
-    */
-    public function user_modify($username,$attributes,$isGUID=false){
-        if ($username===NULL){ return ("Missing compulsory field [username]"); }
-        if (array_key_exists("password",$attributes) && !$this->_use_ssl){ 
-            throw new adLDAPException('SSL must be configured on your webserver and enabled in the class to set passwords.');
-        }
-
-        // Find the dn of the user
-        $user_dn=$this->user_dn($username,$isGUID);
-        if ($user_dn===false){ return (false); }
-        
-        // Translate the update to the LDAP schema                
-        $mod=$this->adldap_schema($attributes);
-        
-        // Check to see if this is an enabled status update
-        if (!$mod && !array_key_exists("enabled", $attributes)){ return (false); }
-        
-        // Set the account control attribute (only if specified)
-        if (array_key_exists("enabled",$attributes)){
-            if ($attributes["enabled"]){ $control_options=array("NORMAL_ACCOUNT"); }
-            else { $control_options=array("NORMAL_ACCOUNT","ACCOUNTDISABLE"); }
-            $mod["userAccountControl"][0]=$this->account_control($control_options);
-        }
-
-        // Do the update
-        $result=@ldap_modify($this->_conn,$user_dn,$mod);
-        if ($result==false){ return (false); }
-        
-        return (true);
-    }
-    
-    /**
-    * Disable a user account
-    * 
-    * @param string $username The username to disable
-    * @param bool $isGUID Is the username passed a GUID or a samAccountName
-    * @return bool
-    */
-    public function user_disable($username,$isGUID=false){
-        if ($username===NULL){ return ("Missing compulsory field [username]"); }
-        $attributes=array("enabled"=>0);
-        $result = $this->user_modify($username, $attributes, $isGUID);
-        if ($result==false){ return (false); }
-        
-        return (true);
-    }
-    
-    /**
-    * Enable a user account
-    * 
-    * @param string $username The username to enable
-    * @param bool $isGUID Is the username passed a GUID or a samAccountName
-    * @return bool
-    */
-    public function user_enable($username,$isGUID=false){
-        if ($username===NULL){ return ("Missing compulsory field [username]"); }
-        $attributes=array("enabled"=>1);
-        $result = $this->user_modify($username, $attributes, $isGUID);
-        if ($result==false){ return (false); }
-        
-        return (true);
-    }
-    
-    /**
-    * Set the password of a user - This must be performed over SSL
-    * 
-    * @param string $username The username to modify
-    * @param string $password The new password
-    * @param bool $isGUID Is the username passed a GUID or a samAccountName
-    * @return bool
-    */
-    public function user_password($username,$password,$isGUID=false){
-        if ($username===NULL){ return (false); }
-        if ($password===NULL){ return (false); }
-        if (!$this->_bind){ return (false); }
-        if (!$this->_use_ssl && !$this->_use_tls){ 
-            throw new adLDAPException('SSL must be configured on your webserver and enabled in the class to set passwords.');
-        }
-        
-        $user_dn=$this->user_dn($username,$isGUID);
-        if ($user_dn===false){ return (false); }
-                
-        $add=array();
-        $add["unicodePwd"][0]=$this->encode_password($password);
-        
-        $result=ldap_mod_replace($this->_conn,$user_dn,$add);
-        if ($result==false){ return (false); }
-        
-        return (true);
-    }
-    
-    /**
-    * Return a list of all users in AD
-    * 
-    * @param bool $include_desc Return a description of the user
-    * @param string $search Search parameter
-    * @param bool $sorted Sort the user accounts
-    * @return array
-    */
-    public function all_users($include_desc = false, $search = "*", $sorted = true){
-        if (!$this->_bind){ return (false); }
-        
-        // Perform the search and grab all their details
-        $filter = "(&(objectClass=user)(samaccounttype=". ADLDAP_NORMAL_ACCOUNT .")(objectCategory=person)(cn=".$search."))";
-        $fields=array("samaccountname","displayname");
-        $sr=ldap_search($this->_conn,$this->_base_dn,$filter,$fields);
-        $entries = ldap_get_entries($this->_conn, $sr);
-
-        $users_array = array();
-        for ($i=0; $i<$entries["count"]; $i++){
-            if ($include_desc && strlen($entries[$i]["displayname"][0])>0){
-                $users_array[ $entries[$i]["samaccountname"][0] ] = $entries[$i]["displayname"][0];
-            } elseif ($include_desc){
-                $users_array[ $entries[$i]["samaccountname"][0] ] = $entries[$i]["samaccountname"][0];
-            } else {
-                array_push($users_array, $entries[$i]["samaccountname"][0]);
-            }
-        }
-        if ($sorted){ asort($users_array); }
-        return ($users_array);
-    }
-    
-    /**
-    * Converts a username (samAccountName) to a GUID
-    * 
-    * @param string $username The username to query
-    * @return string
-    */
-    public function username2guid($username) {
-        if (!$this->_bind){ return (false); }
-        if ($username === null){ return ("Missing compulsory field [username]"); }
-        
-        $filter = "samaccountname=" . $username; 
-        $fields = array("objectGUID"); 
-        $sr = @ldap_search($this->_conn, $this->_base_dn, $filter, $fields); 
-        if (ldap_count_entries($this->_conn, $sr) > 0) { 
-            $entry = @ldap_first_entry($this->_conn, $sr); 
-            $guid = @ldap_get_values_len($this->_conn, $entry, 'objectGUID'); 
-            $strGUID = $this->binary2text($guid[0]);          
-            return ($strGUID); 
-        }
-        else { 
-            return (false); 
-        } 
-    }
-    
-    /**
-    * Move a user account to a different OU
-    *
-    * @param string $username The username to move (please be careful here!)
-    * @param array $container The container or containers to move the user to (please be careful here!).
-    * accepts containers in 1. parent 2. child order
-    * @return array
-    */
-    public function user_move($username, $container) {
-        if (!$this->_bind){ return (false); }
-        if ($username === null){ return ("Missing compulsory field [username]"); }
-        if ($container === null){ return ("Missing compulsory field [container]"); }
-        if (!is_array($container)){ return ("Container must be an array"); }
-        
-        $userinfo = $this->user_info($username, array("*"));
-        $dn = $userinfo[0]['distinguishedname'][0];
-        $newrdn = "cn=" . $username;
-        $container = array_reverse($container);
-        $newcontainer = "ou=" . implode(",ou=",$container);
-        $newbasedn = strtolower($newcontainer) . "," . $this->_base_dn;
-        $result=@ldap_rename($this->_conn,$dn,$newrdn,$newbasedn,true);
-        if ($result !== true) {
-            return (false);
-        }
-        return (true);
-    }
-    
-    //*****************************************************************************************************************
-    // CONTACT FUNCTIONS
-    // * Still work to do in this area, and new functions to write
-    
-    /**
-    * Create a contact
-    * 
-    * @param array $attributes The attributes to set to the contact
-    * @return bool
-    */
-    public function contact_create($attributes){
-        // Check for compulsory fields
-        if (!array_key_exists("display_name",$attributes)){ return ("Missing compulsory field [display_name]"); }
-        if (!array_key_exists("email",$attributes)){ return ("Missing compulsory field [email]"); }
-        if (!array_key_exists("container",$attributes)){ return ("Missing compulsory field [container]"); }
-        if (!is_array($attributes["container"])){ return ("Container attribute must be an array."); }
-
-        // Translate the schema
-        $add=$this->adldap_schema($attributes);
-        
-        // Additional stuff only used for adding contacts
-        $add["cn"][0]=$attributes["display_name"];
-        $add["objectclass"][0]="top";
-        $add["objectclass"][1]="person";
-        $add["objectclass"][2]="organizationalPerson";
-        $add["objectclass"][3]="contact"; 
-        if (!isset($attributes['exchange_hidefromlists'])) {
-            $add["msExchHideFromAddressLists"][0]="TRUE";
-        }
-
-        // Determine the container
-        $attributes["container"]=array_reverse($attributes["container"]);
-        $container="OU=".implode(",OU=",$attributes["container"]);
-
-        // Add the entry
-        $result=@ldap_add($this->_conn, "CN=".$add["cn"][0].", ".$container.",".$this->_base_dn, $add);
-        if ($result!=true){ return (false); }
-        
-        return (true);
-    }  
-    
-    /**
-    * Determine the list of groups a contact is a member of
-    * 
-    * @param string $distinguisedname The full DN of a contact
-    * @param bool $recursive Recursively check groups
-    * @return array
-    */
-    public function contact_groups($distinguishedname,$recursive=NULL){
-        if ($distinguishedname===NULL){ return (false); }
-        if ($recursive===NULL){ $recursive=$this->_recursive_groups; } //use the default option if they haven't set it
-        if (!$this->_bind){ return (false); }
-        
-        // Search the directory for their information
-        $info=@$this->contact_info($distinguishedname,array("memberof","primarygroupid"));
-        $groups=$this->nice_names($info[0]["memberof"]); //presuming the entry returned is our contact
-
-        if ($recursive === true){
-            foreach ($groups as $id => $group_name){
-                $extra_groups=$this->recursive_groups($group_name);
-                $groups=array_merge($groups,$extra_groups);
-            }
-        }
-        
-        return ($groups);
-    }
-    
-    /**
-    * Get contact information
-    * 
-    * @param string $distinguisedname The full DN of a contact
-    * @param array $fields Attributes to be returned
-    * @return array
-    */
-    public function contact_info($distinguishedname,$fields=NULL){
-        if ($distinguishedname===NULL){ return (false); }
-        if (!$this->_bind){ return (false); }
-
-        $filter="distinguishedName=".$distinguishedname;
-        if ($fields===NULL){ $fields=array("distinguishedname","mail","memberof","department","displayname","telephonenumber","primarygroupid","objectsid"); }
-        $sr=ldap_search($this->_conn,$this->_base_dn,$filter,$fields);
-        $entries = ldap_get_entries($this->_conn, $sr);
-        
-        if ($entries[0]['count'] >= 1) {
-            // AD does not return the primary group in the ldap query, we may need to fudge it
-            if ($this->_real_primarygroup && isset($entries[0]["primarygroupid"][0]) && isset($entries[0]["primarygroupid"][0])){
-                //$entries[0]["memberof"][]=$this->group_cn($entries[0]["primarygroupid"][0]);
-                $entries[0]["memberof"][]=$this->get_primary_group($entries[0]["primarygroupid"][0], $entries[0]["objectsid"][0]);
-            } else {
-                $entries[0]["memberof"][]="CN=Domain Users,CN=Users,".$this->_base_dn;
-            }
-        }
-        
-        $entries[0]["memberof"]["count"]++;
-        return ($entries);
-    }
-    
-    /**
-    * Determine if a contact is a member of a group
-    * 
-    * @param string $distinguisedname The full DN of a contact
-    * @param string $group The group name to query
-    * @param bool $recursive Recursively check groups
-    * @return bool
-    */
-    public function contact_ingroup($distinguisedname,$group,$recursive=NULL){
-        if ($distinguisedname===NULL){ return (false); }
-        if ($group===NULL){ return (false); }
-        if (!$this->_bind){ return (false); }
-        if ($recursive===NULL){ $recursive=$this->_recursive_groups; } //use the default option if they haven't set it
-        
-        // Get a list of the groups
-        $groups=$this->contact_groups($distinguisedname,array("memberof"),$recursive);
-        
-        // Return true if the specified group is in the group list
-        if (in_array($group,$groups)){ return (true); }
-
-        return (false);
-    }          
-    
-    /**
-    * Modify a contact
-    * 
-    * @param string $distinguishedname The contact to query
-    * @param array $attributes The attributes to modify.  Note if you set the enabled attribute you must not specify any other attributes
-    * @return bool
-    */
-    public function contact_modify($distinguishedname,$attributes){
-        if ($distinguishedname===NULL){ return ("Missing compulsory field [distinguishedname]"); }
-        
-        // Translate the update to the LDAP schema                
-        $mod=$this->adldap_schema($attributes);
-        
-        // Check to see if this is an enabled status update
-        if (!$mod){ return (false); }
-        
-        // Do the update
-        $result=ldap_modify($this->_conn,$distinguishedname,$mod);
-        if ($result==false){ return (false); }
-        
-        return (true);
-    }
-    
-    /**
-    * Delete a contact
-    * 
-    * @param string $distinguishedname The contact dn to delete (please be careful here!)
-    * @return array
-    */
-    public function contact_delete($distinguishedname) {
-        $result = $this->dn_delete($distinguishedname);
-        if ($result!=true){ return (false); }       
-        return (true);
-    }
-    
-    /**
-    * Return a list of all contacts
-    * 
-    * @param bool $include_desc Include a description of a contact
-    * @param string $search The search parameters
-    * @param bool $sorted Whether to sort the results
-    * @return array
-    */
-    public function all_contacts($include_desc = false, $search = "*", $sorted = true){
-        if (!$this->_bind){ return (false); }
-        
-        // Perform the search and grab all their details
-        $filter = "(&(objectClass=contact)(cn=".$search."))";
-        $fields=array("displayname","distinguishedname");           
-        $sr=ldap_search($this->_conn,$this->_base_dn,$filter,$fields);
-        $entries = ldap_get_entries($this->_conn, $sr);
-
-        $users_array = array();
-        for ($i=0; $i<$entries["count"]; $i++){
-            if ($include_desc && strlen($entries[$i]["displayname"][0])>0){
-                $users_array[ $entries[$i]["distinguishedname"][0] ] = $entries[$i]["displayname"][0];
-            } elseif ($include_desc){
-                $users_array[ $entries[$i]["distinguishedname"][0] ] = $entries[$i]["distinguishedname"][0];
-            } else {
-                array_push($users_array, $entries[$i]["distinguishedname"][0]);
-            }
-        }
-        if ($sorted){ asort($users_array); }
-        return ($users_array);
-    }
-    
-    //*****************************************************************************************************************
-    // FOLDER FUNCTIONS
-    
-    /**
-    * Returns a folder listing for a specific OU
-    * See http://adldap.sourceforge.net/wiki/doku.php?id=api_folder_functions
-    * 
-    * @param array $folder_name An array to the OU you wish to list. 
-    *                           If set to NULL will list the root, strongly recommended to set 
-    *                           $recursive to false in that instance!
-    * @param string $dn_type The type of record to list.  This can be ADLDAP_FOLDER or ADLDAP_CONTAINER.
-    * @param bool $recursive Recursively search sub folders
-    * @param bool $type Specify a type of object to search for
-    * @return array
-    */
-    public function folder_list($folder_name = NULL, $dn_type = ADLDAP_FOLDER, $recursive = NULL, $type = NULL) {
-        if ($recursive===NULL){ $recursive=$this->_recursive_groups; } //use the default option if they haven't set it
-        if (!$this->_bind){ return (false); }
-
-        $filter = '(&';
-        if ($type !== NULL) {
-            switch ($type) {
-                case 'contact':
-                    $filter .= '(objectClass=contact)';
-                    break;
-                case 'computer':
-                    $filter .= '(objectClass=computer)';
-                    break;
-                case 'group':
-                    $filter .= '(objectClass=group)';
-                    break;
-                case 'folder':
-                    $filter .= '(objectClass=organizationalUnit)';
-                    break;
-                case 'container':
-                    $filter .= '(objectClass=container)';
-                    break;
-                case 'domain':
-                    $filter .= '(objectClass=builtinDomain)';
-                    break;
-                default:
-                    $filter .= '(objectClass=user)';
-                    break;   
-            }
-        }
-        else {
-            $filter .= '(objectClass=*)';   
-        }
-        // If the folder name is null then we will search the root level of AD
-        // This requires us to not have an OU= part, just the base_dn
-        $searchou = $this->_base_dn;
-        if (is_array($folder_name)) {
-            $ou = $dn_type . "=".implode("," . $dn_type . "=",$folder_name);
-            $filter .= '(!(distinguishedname=' . $ou . ',' . $this->_base_dn . ')))';
-            $searchou = $ou . ',' . $this->_base_dn;
-        }
-        else {
-            $filter .= '(!(distinguishedname=' . $this->_base_dn . ')))';
-        }
-
-        if ($recursive === true) {
-            $sr=ldap_search($this->_conn, $searchou, $filter, array('objectclass', 'distinguishedname', 'samaccountname'));
-            $entries = @ldap_get_entries($this->_conn, $sr);
-            if (is_array($entries)) {
-                return $entries;
-            }
-        }
-        else {
-            $sr=ldap_list($this->_conn, $searchou, $filter, array('objectclass', 'distinguishedname', 'samaccountname'));
-            $entries = @ldap_get_entries($this->_conn, $sr);
-            if (is_array($entries)) {
-                return $entries;
-            }
-        }
-        
-        return false;
-    }
-    
-    //*****************************************************************************************************************
-    // COMPUTER FUNCTIONS
-    
-    /**
-    * Get information about a specific computer
-    * 
-    * @param string $computer_name The name of the computer
-    * @param array $fields Attributes to return
-    * @return array
-    */
-    public function computer_info($computer_name,$fields=NULL){
-        if ($computer_name===NULL){ return (false); }
-        if (!$this->_bind){ return (false); }
-
-        $filter="(&(objectClass=computer)(cn=".$computer_name."))";
-        if ($fields===NULL){ $fields=array("memberof","cn","displayname","dnshostname","distinguishedname","objectcategory","operatingsystem","operatingsystemservicepack","operatingsystemversion"); }
-        $sr=ldap_search($this->_conn,$this->_base_dn,$filter,$fields);
-        $entries = ldap_get_entries($this->_conn, $sr);
-        
-        return ($entries);
-    }
-    
-    /**
-    * Check if a computer is in a group
-    * 
-    * @param string $computer_name The name of the computer
-    * @param string $group The group to check
-    * @param bool $recursive Whether to check recursively
-    * @return array
-    */
-    public function computer_ingroup($computer_name,$group,$recursive=NULL){
-        if ($computer_name===NULL){ return (false); }
-        if ($group===NULL){ return (false); }
-        if (!$this->_bind){ return (false); }
-        if ($recursive===NULL){ $recursive=$this->_recursive_groups; } // use the default option if they haven't set it
-
-        //get a list of the groups
-        $groups=$this->computer_groups($computer_name,array("memberof"),$recursive);
-
-        //return true if the specified group is in the group list
-        if (in_array($group,$groups)){ return (true); }
-
-        return (false);
-    }
-    
-    /**
-    * Get the groups a computer is in
-    * 
-    * @param string $computer_name The name of the computer
-    * @param bool $recursive Whether to check recursively
-    * @return array
-    */
-    public function computer_groups($computer_name,$recursive=NULL){
-        if ($computer_name===NULL){ return (false); }
-        if ($recursive===NULL){ $recursive=$this->_recursive_groups; } //use the default option if they haven't set it
-        if (!$this->_bind){ return (false); }
-
-        //search the directory for their information
-        $info=@$this->computer_info($computer_name,array("memberof","primarygroupid"));
-        $groups=$this->nice_names($info[0]["memberof"]); //presuming the entry returned is our guy (unique usernames)
-
-        if ($recursive === true){
-            foreach ($groups as $id => $group_name){
-              $extra_groups=$this->recursive_groups($group_name);
-              $groups=array_merge($groups,$extra_groups);
-            }
-        }
-
-        return ($groups);
-    }
-    
-    //************************************************************************************************************
-    //  ORGANIZATIONAL UNIT FUNCTIONS
-    
-     /**
-    * Create an organizational unit
-    * 
-    * @param array $attributes Default attributes of the ou
-    * @return bool
-    */
-    public function ou_create($attributes){
-        if (!is_array($attributes)){ return ("Attributes must be an array"); }
-        if (!array_key_exists("ou_name",$attributes)){ return ("Missing compulsory field [ou_name]"); }
-        if (!array_key_exists("container",$attributes)){ return ("Missing compulsory field [container]"); }
-        if (!is_array($attributes["container"])){ return ("Container attribute must be an array."); }
-        $attributes["container"]=array_reverse($attributes["container"]);
-
-        $add=array();
-        $add["objectClass"] = "organizationalUnit";
-
-        $container="OU=".implode(",OU=",$attributes["container"]);
-        $result=ldap_add($this->_conn,"CN=".$add["cn"].", ".$container.",".$this->_base_dn,$add);
-        if ($result!=true){ return (false); }
-        
-        return (true);
-    }
-    
-    //************************************************************************************************************
-    // EXCHANGE FUNCTIONS
-    
-    /**
-    * Create an Exchange account
-    * 
-    * @param string $username The username of the user to add the Exchange account to
-    * @param array $storagegroup The mailbox, Exchange Storage Group, for the user account, this must be a full CN
-    *                            If the storage group has a different base_dn to the adLDAP configuration, set it using $base_dn
-    * @param string $emailaddress The primary email address to add to this user
-    * @param string $mailnickname The mail nick name.  If mail nickname is blank, the username will be used
-    * @param bool $usedefaults Indicates whether the store should use the default quota, rather than the per-mailbox quota.
-    * @param string $base_dn Specify an alternative base_dn for the Exchange storage group
-    * @param bool $isGUID Is the username passed a GUID or a samAccountName
-    * @return bool
-    */
-    public function exchange_create_mailbox($username, $storagegroup, $emailaddress, $mailnickname=NULL, $usedefaults=TRUE, $base_dn=NULL, $isGUID=false){
-        if ($username===NULL){ return ("Missing compulsory field [username]"); }     
-        if ($storagegroup===NULL){ return ("Missing compulsory array [storagegroup]"); }
-        if (!is_array($storagegroup)){ return ("[storagegroup] must be an array"); }
-        if ($emailaddress===NULL){ return ("Missing compulsory field [emailaddress]"); }
-        
-        if ($base_dn===NULL) {
-            $base_dn = $this->_base_dn;   
-        }
-        
-        $container="CN=".implode(",CN=",$storagegroup);
-        
-        if ($mailnickname===NULL) { $mailnickname=$username; }
-        $mdbUseDefaults = $this->bool2str($usedefaults);
-        
-        $attributes = array(
-            'exchange_homemdb'=>$container.",".$base_dn,
-            'exchange_proxyaddress'=>'SMTP:' . $emailaddress,
-            'exchange_mailnickname'=>$mailnickname,
-            'exchange_usedefaults'=>$mdbUseDefaults
-        );
-        $result = $this->user_modify($username,$attributes,$isGUID);
-        if ($result==false){ return (false); }
-        return (true);
-    }
-    
-    /**
-    * Add an X400 address to Exchange
-    * See http://tools.ietf.org/html/rfc1685 for more information.
-    * An X400 Address looks similar to this X400:c=US;a= ;p=Domain;o=Organization;s=Doe;g=John;
-    * 
-    * @param string $username The username of the user to add the X400 to to
-    * @param string $country Country
-    * @param string $admd Administration Management Domain
-    * @param string $pdmd Private Management Domain (often your AD domain)
-    * @param string $org Organization
-    * @param string $surname Surname
-    * @param string $givenName Given name
-    * @param bool $isGUID Is the username passed a GUID or a samAccountName
-    * @return bool
-    */
-    public function exchange_add_X400($username, $country, $admd, $pdmd, $org, $surname, $givenname, $isGUID=false) {
-        if ($username===NULL){ return ("Missing compulsory field [username]"); }     
-        
-        $proxyvalue = 'X400:';
-            
-        // Find the dn of the user
-        $user=$this->user_info($username,array("cn","proxyaddresses"), $isGUID);
-        if ($user[0]["dn"]===NULL){ return (false); }
-        $user_dn=$user[0]["dn"];
-        
-        // We do not have to demote an email address from the default so we can just add the new proxy address
-        $attributes['exchange_proxyaddress'] = $proxyvalue . 'c=' . $country . ';a=' . $admd . ';p=' . $pdmd . ';o=' . $org . ';s=' . $surname . ';g=' . $givenname . ';';
-       
-        // Translate the update to the LDAP schema                
-        $add=$this->adldap_schema($attributes);
-        
-        if (!$add){ return (false); }
-        
-        // Do the update
-        // Take out the @ to see any errors, usually this error might occur because the address already
-        // exists in the list of proxyAddresses
-        $result=@ldap_mod_add($this->_conn,$user_dn,$add);
-        if ($result==false){ return (false); }
-        
-        return (true);
-    }
-    
-    /**
-    * Add an address to Exchange
-    * 
-    * @param string $username The username of the user to add the Exchange account to
-    * @param string $emailaddress The email address to add to this user
-    * @param bool $default Make this email address the default address, this is a bit more intensive as we have to demote any existing default addresses
-    * @param bool $isGUID Is the username passed a GUID or a samAccountName
-    * @return bool
-    */
-    public function exchange_add_address($username, $emailaddress, $default=FALSE, $isGUID=false) {
-        if ($username===NULL){ return ("Missing compulsory field [username]"); }     
-        if ($emailaddress===NULL) { return ("Missing compulsory fields [emailaddress]"); }
-        
-        $proxyvalue = 'smtp:';
-        if ($default === true) {
-            $proxyvalue = 'SMTP:';
-        }
-              
-        // Find the dn of the user
-        $user=$this->user_info($username,array("cn","proxyaddresses"),$isGUID);
-        if ($user[0]["dn"]===NULL){ return (false); }
-        $user_dn=$user[0]["dn"];
-        
-        // We need to scan existing proxy addresses and demote the default one
-        if (is_array($user[0]["proxyaddresses"]) && $default===true) {
-            $modaddresses = array();
-            for ($i=0;$i_conn,$user_dn,$modaddresses);
-            if ($result==false){ return (false); }
-            
-            return (true);
-        }
-        else {
-            // We do not have to demote an email address from the default so we can just add the new proxy address
-            $attributes['exchange_proxyaddress'] = $proxyvalue . $emailaddress;
-            
-            // Translate the update to the LDAP schema                
-            $add=$this->adldap_schema($attributes);
-            
-            if (!$add){ return (false); }
-            
-            // Do the update
-            // Take out the @ to see any errors, usually this error might occur because the address already
-            // exists in the list of proxyAddresses
-            $result=@ldap_mod_add($this->_conn,$user_dn,$add);
-            if ($result==false){ return (false); }
-            
-            return (true);
-        }
-    }
-    
-    /**
-    * Remove an address to Exchange
-    * If you remove a default address the account will no longer have a default, 
-    * we recommend changing the default address first
-    * 
-    * @param string $username The username of the user to add the Exchange account to
-    * @param string $emailaddress The email address to add to this user
-    * @param bool $isGUID Is the username passed a GUID or a samAccountName
-    * @return bool
-    */
-    public function exchange_del_address($username, $emailaddress, $isGUID=false) {
-        if ($username===NULL){ return ("Missing compulsory field [username]"); }     
-        if ($emailaddress===NULL) { return ("Missing compulsory fields [emailaddress]"); }
-        
-        // Find the dn of the user
-        $user=$this->user_info($username,array("cn","proxyaddresses"),$isGUID);
-        if ($user[0]["dn"]===NULL){ return (false); }
-        $user_dn=$user[0]["dn"];
-        
-        if (is_array($user[0]["proxyaddresses"])) {
-            $mod = array();
-            for ($i=0;$i_conn,$user_dn,$mod);
-            if ($result==false){ return (false); }
-            
-            return (true);
-        }
-        else {
-            return (false);
-        }
-    }
-    /**
-    * Change the default address
-    * 
-    * @param string $username The username of the user to add the Exchange account to
-    * @param string $emailaddress The email address to make default
-    * @param bool $isGUID Is the username passed a GUID or a samAccountName
-    * @return bool
-    */
-    public function exchange_primary_address($username, $emailaddress, $isGUID=false) {
-        if ($username===NULL){ return ("Missing compulsory field [username]"); }     
-        if ($emailaddress===NULL) { return ("Missing compulsory fields [emailaddress]"); }
-        
-        // Find the dn of the user
-        $user=$this->user_info($username,array("cn","proxyaddresses"), $isGUID);
-        if ($user[0]["dn"]===NULL){ return (false); }
-        $user_dn=$user[0]["dn"];
-        
-        if (is_array($user[0]["proxyaddresses"])) {
-            $modaddresses = array();
-            for ($i=0;$i_conn,$user_dn,$modaddresses);
-            if ($result==false){ return (false); }
-            
-            return (true);
-        }
-        
-    }
-    
-    /**
-    * Mail enable a contact
-    * Allows email to be sent to them through Exchange
-    * 
-    * @param string $distinguishedname The contact to mail enable
-    * @param string $emailaddress The email address to allow emails to be sent through
-    * @param string $mailnickname The mailnickname for the contact in Exchange.  If NULL this will be set to the display name
-    * @return bool
-    */
-    public function exchange_contact_mailenable($distinguishedname, $emailaddress, $mailnickname=NULL){
-        if ($distinguishedname===NULL){ return ("Missing compulsory field [distinguishedname]"); }   
-        if ($emailaddress===NULL){ return ("Missing compulsory field [emailaddress]"); }  
-        
-        if ($mailnickname !== NULL) {
-            // Find the dn of the user
-            $user=$this->contact_info($distinguishedname,array("cn","displayname"));
-            if ($user[0]["displayname"]===NULL){ return (false); }
-            $mailnickname = $user[0]['displayname'][0];
-        }
-        
-        $attributes = array("email"=>$emailaddress,"contact_email"=>"SMTP:" . $emailaddress,"exchange_proxyaddress"=>"SMTP:" . $emailaddress,"exchange_mailnickname"=>$mailnickname);
-         
-        // Translate the update to the LDAP schema                
-        $mod=$this->adldap_schema($attributes);
-        
-        // Check to see if this is an enabled status update
-        if (!$mod){ return (false); }
-        
-        // Do the update
-        $result=ldap_modify($this->_conn,$distinguishedname,$mod);
-        if ($result==false){ return (false); }
-        
-        return (true);
-    }
-    
-    /**
-    * Returns a list of Exchange Servers in the ConfigurationNamingContext of the domain
-    * 
-    * @param array $attributes An array of the AD attributes you wish to return
-    * @return array
-    */
-    public function exchange_servers($attributes = array('cn','distinguishedname','serialnumber')) {
-        if (!$this->_bind){ return (false); }
-        
-        $configurationNamingContext = $this->get_root_dse(array('configurationnamingcontext'));
-        $sr = @ldap_search($this->_conn,$configurationNamingContext[0]['configurationnamingcontext'][0],'(&(objectCategory=msExchExchangeServer))',$attributes);
-        $entries = @ldap_get_entries($this->_conn, $sr);
-        return $entries;
-    }
-    
-    /**
-    * Returns a list of Storage Groups in Exchange for a given mail server
-    * 
-    * @param string $exchangeServer The full DN of an Exchange server.  You can use exchange_servers() to find the DN for your server
-    * @param array $attributes An array of the AD attributes you wish to return
-    * @param bool $recursive If enabled this will automatically query the databases within a storage group
-    * @return array
-    */
-    public function exchange_storage_groups($exchangeServer, $attributes = array('cn','distinguishedname'), $recursive = NULL) {
-        if (!$this->_bind){ return (false); }
-        if ($exchangeServer===NULL){ return ("Missing compulsory field [exchangeServer]"); }
-        if ($recursive===NULL){ $recursive=$this->_recursive_groups; }
-
-        $filter = '(&(objectCategory=msExchStorageGroup))';
-        $sr=@ldap_search($this->_conn, $exchangeServer, $filter, $attributes);
-        $entries = @ldap_get_entries($this->_conn, $sr);
-
-        if ($recursive === true) {
-            for ($i=0; $i<$entries['count']; $i++) {
-                $entries[$i]['msexchprivatemdb'] = $this->exchange_storage_databases($entries[$i]['distinguishedname'][0]);       
-            }
-        }
-        
-        return $entries;
-    }
-    
-    /**
-    * Returns a list of Databases within any given storage group in Exchange for a given mail server
-    * 
-    * @param string $storageGroup The full DN of an Storage Group.  You can use exchange_storage_groups() to find the DN 
-    * @param array $attributes An array of the AD attributes you wish to return
-    * @return array
-    */
-    public function exchange_storage_databases($storageGroup, $attributes = array('cn','distinguishedname','displayname')) {
-        if (!$this->_bind){ return (false); }
-        if ($storageGroup===NULL){ return ("Missing compulsory field [storageGroup]"); }
-        
-        $filter = '(&(objectCategory=msExchPrivateMDB))';
-        $sr=@ldap_search($this->_conn, $storageGroup, $filter, $attributes);
-        $entries = @ldap_get_entries($this->_conn, $sr);
-        return $entries;
-    }
-    
-    //************************************************************************************************************
-    // SERVER FUNCTIONS
-    
-    /**
-    * Find the Base DN of your domain controller
-    * 
-    * @return string
-    */
-    public function find_base_dn() {
-        $namingContext = $this->get_root_dse(array('defaultnamingcontext'));   
-        return $namingContext[0]['defaultnamingcontext'][0];
-    }
-    
-    /**
-    * Get the RootDSE properties from a domain controller
-    * 
-    * @param array $attributes The attributes you wish to query e.g. defaultnamingcontext
-    * @return array
-    */
-    public function get_root_dse($attributes = array("*", "+")) {
-        if (!$this->_bind){ return (false); }
-        
-        $sr = @ldap_read($this->_conn, NULL, 'objectClass=*', $attributes);
-        $entries = @ldap_get_entries($this->_conn, $sr);
-        return $entries;
-    }
-
-    //************************************************************************************************************
-    // UTILITY FUNCTIONS (Many of these functions are protected and can only be called from within the class)
-
-    /**
-    * Get last error from Active Directory
-    * 
-    * This function gets the last message from Active Directory
-    * This may indeed be a 'Success' message but if you get an unknown error
-    * it might be worth calling this function to see what errors were raised
-    * 
-    * return string
-    */
-    public function get_last_error() {
-        return @ldap_error($this->_conn);
-    }
-    
-    /**
-    * Detect LDAP support in php
-    * 
-    * @return bool
-    */    
-    protected function ldap_supported() {
-        if (!function_exists('ldap_connect')) {
-            return (false);   
-        }
-        return (true);
-    }
-    
-    /**
-    * Schema
-    * 
-    * @param array $attributes Attributes to be queried
-    * @return array
-    */    
-    protected function adldap_schema($attributes){
-    
-        // LDAP doesn't like NULL attributes, only set them if they have values
-        // If you wish to remove an attribute you should set it to a space
-        // TO DO: Adapt user_modify to use ldap_mod_delete to remove a NULL attribute
-        $mod=array();
-        
-        // Check every attribute to see if it contains 8bit characters and then UTF8 encode them
-        array_walk($attributes, array($this, 'encode8bit'));
-
-        if ($attributes["address_city"]){ $mod["l"][0]=$attributes["address_city"]; }
-        if ($attributes["address_code"]){ $mod["postalCode"][0]=$attributes["address_code"]; }
-        //if ($attributes["address_country"]){ $mod["countryCode"][0]=$attributes["address_country"]; } // use country codes?
-        if ($attributes["address_country"]){ $mod["c"][0]=$attributes["address_country"]; }
-        if ($attributes["address_pobox"]){ $mod["postOfficeBox"][0]=$attributes["address_pobox"]; }
-        if ($attributes["address_state"]){ $mod["st"][0]=$attributes["address_state"]; }
-        if ($attributes["address_street"]){ $mod["streetAddress"][0]=$attributes["address_street"]; }
-        if ($attributes["company"]){ $mod["company"][0]=$attributes["company"]; }
-        if ($attributes["change_password"]){ $mod["pwdLastSet"][0]=0; }
-        if ($attributes["department"]){ $mod["department"][0]=$attributes["department"]; }
-        if ($attributes["description"]){ $mod["description"][0]=$attributes["description"]; }
-        if ($attributes["display_name"]){ $mod["displayName"][0]=$attributes["display_name"]; }
-        if ($attributes["email"]){ $mod["mail"][0]=$attributes["email"]; }
-        if ($attributes["expires"]){ $mod["accountExpires"][0]=$attributes["expires"]; } //unix epoch format?
-        if ($attributes["firstname"]){ $mod["givenName"][0]=$attributes["firstname"]; }
-        if ($attributes["home_directory"]){ $mod["homeDirectory"][0]=$attributes["home_directory"]; }
-        if ($attributes["home_drive"]){ $mod["homeDrive"][0]=$attributes["home_drive"]; }
-        if ($attributes["initials"]){ $mod["initials"][0]=$attributes["initials"]; }
-        if ($attributes["logon_name"]){ $mod["userPrincipalName"][0]=$attributes["logon_name"]; }
-        if ($attributes["manager"]){ $mod["manager"][0]=$attributes["manager"]; }  //UNTESTED ***Use DistinguishedName***
-        if ($attributes["office"]){ $mod["physicalDeliveryOfficeName"][0]=$attributes["office"]; }
-        if ($attributes["password"]){ $mod["unicodePwd"][0]=$this->encode_password($attributes["password"]); }
-        if ($attributes["profile_path"]){ $mod["profilepath"][0]=$attributes["profile_path"]; }
-        if ($attributes["script_path"]){ $mod["scriptPath"][0]=$attributes["script_path"]; }
-        if ($attributes["surname"]){ $mod["sn"][0]=$attributes["surname"]; }
-        if ($attributes["title"]){ $mod["title"][0]=$attributes["title"]; }
-        if ($attributes["telephone"]){ $mod["telephoneNumber"][0]=$attributes["telephone"]; }
-        if ($attributes["mobile"]){ $mod["mobile"][0]=$attributes["mobile"]; }
-        if ($attributes["pager"]){ $mod["pager"][0]=$attributes["pager"]; }
-        if ($attributes["ipphone"]){ $mod["ipphone"][0]=$attributes["ipphone"]; }
-        if ($attributes["web_page"]){ $mod["wWWHomePage"][0]=$attributes["web_page"]; }
-        if ($attributes["fax"]){ $mod["facsimileTelephoneNumber"][0]=$attributes["fax"]; }
-        if ($attributes["enabled"]){ $mod["userAccountControl"][0]=$attributes["enabled"]; }
-        
-        // Distribution List specific schema
-        if ($attributes["group_sendpermission"]){ $mod["dlMemSubmitPerms"][0]=$attributes["group_sendpermission"]; }
-        if ($attributes["group_rejectpermission"]){ $mod["dlMemRejectPerms"][0]=$attributes["group_rejectpermission"]; }
-        
-        // Exchange Schema
-        if ($attributes["exchange_homemdb"]){ $mod["homeMDB"][0]=$attributes["exchange_homemdb"]; }
-        if ($attributes["exchange_mailnickname"]){ $mod["mailNickname"][0]=$attributes["exchange_mailnickname"]; }
-        if ($attributes["exchange_proxyaddress"]){ $mod["proxyAddresses"][0]=$attributes["exchange_proxyaddress"]; }
-        if ($attributes["exchange_usedefaults"]){ $mod["mDBUseDefaults"][0]=$attributes["exchange_usedefaults"]; }
-        if ($attributes["exchange_policyexclude"]){ $mod["msExchPoliciesExcluded"][0]=$attributes["exchange_policyexclude"]; }
-        if ($attributes["exchange_policyinclude"]){ $mod["msExchPoliciesIncluded"][0]=$attributes["exchange_policyinclude"]; }       
-        if ($attributes["exchange_addressbook"]){ $mod["showInAddressBook"][0]=$attributes["exchange_addressbook"]; }       
-        
-        // This schema is designed for contacts
-        if ($attributes["exchange_hidefromlists"]){ $mod["msExchHideFromAddressLists"][0]=$attributes["exchange_hidefromlists"]; }
-        if ($attributes["contact_email"]){ $mod["targetAddress"][0]=$attributes["contact_email"]; }
-        
-        //echo ("
"); print_r($mod);
-        /*
-        // modifying a name is a bit fiddly
-        if ($attributes["firstname"] && $attributes["surname"]){
-            $mod["cn"][0]=$attributes["firstname"]." ".$attributes["surname"];
-            $mod["displayname"][0]=$attributes["firstname"]." ".$attributes["surname"];
-            $mod["name"][0]=$attributes["firstname"]." ".$attributes["surname"];
-        }
-        */
-
-        if (count($mod)==0){ return (false); }
-        return ($mod);
-    }
-
-    /**
-    * Coping with AD not returning the primary group
-    * http://support.microsoft.com/?kbid=321360 
-    * 
-    * For some reason it's not possible to search on primarygrouptoken=XXX
-    * If someone can show otherwise, I'd like to know about it :)
-    * this way is resource intensive and generally a pain in the @#%^
-    * 
-    * @deprecated deprecated since version 3.1, see get get_primary_group
-    * @param string $gid Group ID
-    * @return string
-    */
-    protected function group_cn($gid){    
-        if ($gid===NULL){ return (false); }
-        $r=false;
-        
-        $filter="(&(objectCategory=group)(samaccounttype=". ADLDAP_SECURITY_GLOBAL_GROUP ."))";
-        $fields=array("primarygrouptoken","samaccountname","distinguishedname");
-        $sr=ldap_search($this->_conn,$this->_base_dn,$filter,$fields);
-        $entries = ldap_get_entries($this->_conn, $sr);
-        
-        for ($i=0; $i<$entries["count"]; $i++){
-            if ($entries[$i]["primarygrouptoken"][0]==$gid){
-                $r=$entries[$i]["distinguishedname"][0];
-                $i=$entries["count"];
-            }
-        }
-
-        return ($r);
-    }
-    
-    /**
-    * Coping with AD not returning the primary group
-    * http://support.microsoft.com/?kbid=321360 
-    * 
-    * This is a re-write based on code submitted by Bruce which prevents the 
-    * need to search each security group to find the true primary group
-    * 
-    * @param string $gid Group ID
-    * @param string $usersid User's Object SID
-    * @return string
-    */
-    protected function get_primary_group($gid, $usersid){
-        if ($gid===NULL || $usersid===NULL){ return (false); }
-        $r=false;
-
-        $gsid = substr_replace($usersid,pack('V',$gid),strlen($usersid)-4,4);
-        $filter='(objectsid='.$this->getTextSID($gsid).')';
-        $fields=array("samaccountname","distinguishedname");
-        $sr=ldap_search($this->_conn,$this->_base_dn,$filter,$fields);
-        $entries = ldap_get_entries($this->_conn, $sr);
-
-        return $entries[0]['distinguishedname'][0];
-     }
-     
-    /**
-    * Convert a binary SID to a text SID
-    * 
-    * @param string $binsid A Binary SID
-    * @return string
-    */
-     protected function getTextSID($binsid) {
-        $hex_sid = bin2hex($binsid);
-        $rev = hexdec(substr($hex_sid, 0, 2));
-        $subcount = hexdec(substr($hex_sid, 2, 2));
-        $auth = hexdec(substr($hex_sid, 4, 12));
-        $result = "$rev-$auth";
-
-        for ($x=0;$x < $subcount; $x++) {
-            $subauth[$x] =
-                hexdec($this->little_endian(substr($hex_sid, 16 + ($x * 8), 8)));
-                $result .= "-" . $subauth[$x];
-        }
-
-        // Cheat by tacking on the S-
-        return 'S-' . $result;
-     }
-     
-    /**
-    * Converts a little-endian hex number to one that hexdec() can convert
-    * 
-    * @param string $hex A hex code
-    * @return string
-    */
-     protected function little_endian($hex) {
-        $result = '';
-        for ($x = strlen($hex) - 2; $x >= 0; $x = $x - 2) {
-            $result .= substr($hex, $x, 2);
-        }
-        return $result;
-     }
-     
-    /**
-    * Converts a binary attribute to a string
-    * 
-    * @param string $bin A binary LDAP attribute
-    * @return string
-    */
-    protected function binary2text($bin) {
-        $hex_guid = bin2hex($bin); 
-        $hex_guid_to_guid_str = ''; 
-        for($k = 1; $k <= 4; ++$k) { 
-            $hex_guid_to_guid_str .= substr($hex_guid, 8 - 2 * $k, 2); 
-        } 
-        $hex_guid_to_guid_str .= '-'; 
-        for($k = 1; $k <= 2; ++$k) { 
-            $hex_guid_to_guid_str .= substr($hex_guid, 12 - 2 * $k, 2); 
-        } 
-        $hex_guid_to_guid_str .= '-'; 
-        for($k = 1; $k <= 2; ++$k) { 
-            $hex_guid_to_guid_str .= substr($hex_guid, 16 - 2 * $k, 2); 
-        } 
-        $hex_guid_to_guid_str .= '-' . substr($hex_guid, 16, 4); 
-        $hex_guid_to_guid_str .= '-' . substr($hex_guid, 20); 
-        return strtoupper($hex_guid_to_guid_str);   
-    }
-    
-    /**
-    * Converts a binary GUID to a string GUID
-    * 
-    * @param string $binaryGuid The binary GUID attribute to convert
-    * @return string
-    */
-    public function decodeGuid($binaryGuid) {
-        if ($binaryGuid === null){ return ("Missing compulsory field [binaryGuid]"); }
-        
-        $strGUID = $this->binary2text($binaryGuid);          
-        return ($strGUID); 
-    }
-     
-    /**
-    * Converts a string GUID to a hexdecimal value so it can be queried
-    * 
-    * @param string $strGUID A string representation of a GUID
-    * @return string
-    */
-    protected function strguid2hex($strGUID) {
-        $strGUID = str_replace('-', '', $strGUID);
-
-        $octet_str = '\\' . substr($strGUID, 6, 2);
-        $octet_str .= '\\' . substr($strGUID, 4, 2);
-        $octet_str .= '\\' . substr($strGUID, 2, 2);
-        $octet_str .= '\\' . substr($strGUID, 0, 2);
-        $octet_str .= '\\' . substr($strGUID, 10, 2);
-        $octet_str .= '\\' . substr($strGUID, 8, 2);
-        $octet_str .= '\\' . substr($strGUID, 14, 2);
-        $octet_str .= '\\' . substr($strGUID, 12, 2);
-        //$octet_str .= '\\' . substr($strGUID, 16, strlen($strGUID));
-        for ($i=16; $i<=(strlen($strGUID)-2); $i++) {
-            if (($i % 2) == 0) {
-                $octet_str .= '\\' . substr($strGUID, $i, 2);
-            }
-        }
-        
-        return $octet_str;
-    }
-    
-    /**
-    * Obtain the user's distinguished name based on their userid 
-    * 
-    * 
-    * @param string $username The username
-    * @param bool $isGUID Is the username passed a GUID or a samAccountName
-    * @return string
-    */
-    protected function user_dn($username,$isGUID=false){
-        $user=$this->user_info($username,array("cn"),$isGUID);
-        if ($user[0]["dn"]===NULL){ return (false); }
-        $user_dn=$user[0]["dn"];
-        return ($user_dn);
-    }
-
-    /**
-    * Encode a password for transmission over LDAP
-    *
-    * @param string $password The password to encode
-    * @return string
-    */
-    protected function encode_password($password){
-        $password="\"".$password."\"";
-        $encoded="";
-        for ($i=0; $i 
-    * @return string
-    */
-    protected function ldap_slashes($str){
-        return preg_replace('/([\x00-\x1F\*\(\)\\\\])/e',
-                            '"\\\\\".join("",unpack("H2","$1"))',
-                            $str);
-    }
-    
-    /**
-    * Select a random domain controller from your domain controller array
-    * 
-    * @return string
-    */
-    protected function random_controller(){
-        mt_srand(doubleval(microtime()) * 100000000); // For older PHP versions
-        return ($this->_domain_controllers[array_rand($this->_domain_controllers)]);
-    }
-    
-    /**
-    * Account control options
-    *
-    * @param array $options The options to convert to int 
-    * @return int
-    */
-    protected function account_control($options){
-        $val=0;
-
-        if (is_array($options)){
-            if (in_array("SCRIPT",$options)){ $val=$val+1; }
-            if (in_array("ACCOUNTDISABLE",$options)){ $val=$val+2; }
-            if (in_array("HOMEDIR_REQUIRED",$options)){ $val=$val+8; }
-            if (in_array("LOCKOUT",$options)){ $val=$val+16; }
-            if (in_array("PASSWD_NOTREQD",$options)){ $val=$val+32; }
-            //PASSWD_CANT_CHANGE Note You cannot assign this permission by directly modifying the UserAccountControl attribute.
-            //For information about how to set the permission programmatically, see the "Property flag descriptions" section.
-            if (in_array("ENCRYPTED_TEXT_PWD_ALLOWED",$options)){ $val=$val+128; }
-            if (in_array("TEMP_DUPLICATE_ACCOUNT",$options)){ $val=$val+256; }
-            if (in_array("NORMAL_ACCOUNT",$options)){ $val=$val+512; }
-            if (in_array("INTERDOMAIN_TRUST_ACCOUNT",$options)){ $val=$val+2048; }
-            if (in_array("WORKSTATION_TRUST_ACCOUNT",$options)){ $val=$val+4096; }
-            if (in_array("SERVER_TRUST_ACCOUNT",$options)){ $val=$val+8192; }
-            if (in_array("DONT_EXPIRE_PASSWORD",$options)){ $val=$val+65536; }
-            if (in_array("MNS_LOGON_ACCOUNT",$options)){ $val=$val+131072; }
-            if (in_array("SMARTCARD_REQUIRED",$options)){ $val=$val+262144; }
-            if (in_array("TRUSTED_FOR_DELEGATION",$options)){ $val=$val+524288; }
-            if (in_array("NOT_DELEGATED",$options)){ $val=$val+1048576; }
-            if (in_array("USE_DES_KEY_ONLY",$options)){ $val=$val+2097152; }
-            if (in_array("DONT_REQ_PREAUTH",$options)){ $val=$val+4194304; } 
-            if (in_array("PASSWORD_EXPIRED",$options)){ $val=$val+8388608; }
-            if (in_array("TRUSTED_TO_AUTH_FOR_DELEGATION",$options)){ $val=$val+16777216; }
-        }
-        return ($val);
-    }
-    
-    /**
-    * Take an LDAP query and return the nice names, without all the LDAP prefixes (eg. CN, DN)
-    *
-    * @param array $groups
-    * @return array
-    */
-    protected function nice_names($groups){
-
-        $group_array=array();
-        for ($i=0; $i<$groups["count"]; $i++){ // For each group
-            $line=$groups[$i];
-            
-            if (strlen($line)>0){ 
-                // More presumptions, they're all prefixed with CN=
-                // so we ditch the first three characters and the group
-                // name goes up to the first comma
-                $bits=explode(",",$line);
-                $group_array[]=substr($bits[0],3,(strlen($bits[0])-3));
-            }
-        }
-        return ($group_array);    
-    }
-    
-    /**
-    * Delete a distinguished name from Active Directory
-    * You should never need to call this yourself, just use the wrapper functions user_delete and contact_delete
-    *
-    * @param string $dn The distinguished name to delete
-    * @return bool
-    */
-    protected function dn_delete($dn){ 
-        $result=ldap_delete($this->_conn, $dn);
-        if ($result!=true){ return (false); }
-        return (true);
-    }
-    
-    /**
-    * Convert a boolean value to a string
-    * You should never need to call this yourself
-    *
-    * @param bool $bool Boolean value
-    * @return string
-    */
-    protected function bool2str($bool) {
-        return ($bool) ? 'TRUE' : 'FALSE';
-    }
-    
-    /**
-    * Convert 8bit characters e.g. accented characters to UTF8 encoded characters
-    */
-    protected function encode8bit(&$item, $key) {
-        $encode = false;
-        if (is_string($item)) {
-            for ($i=0; $i> 7) {
-                    $encode = true;
-                }
-            }
-        }
-        if ($encode === true && $key != 'password') {
-            $item = utf8_encode($item);   
-        }
-    }    
-}
-
-/**
-* adLDAP Exception Handler
-* 
-* Exceptions of this type are thrown on bind failure or when SSL is required but not configured
-* Example:
-* try {
-*   $adldap = new adLDAP();
-* }
-* catch (adLDAPException $e) {
-*   echo $e;
-*   exit();
-* }
-*/
-class adLDAPException extends Exception {}
-
-?>
\ No newline at end of file
diff --git a/sources/extra_files/wp-content/plugins/simple-ldap-login/readme.txt b/sources/extra_files/wp-content/plugins/simple-ldap-login/readme.txt
deleted file mode 100644
index 745dba6..0000000
--- a/sources/extra_files/wp-content/plugins/simple-ldap-login/readme.txt
+++ /dev/null
@@ -1,218 +0,0 @@
-=== Plugin Name ===
-Contributors: clifgriffin
-Donate link: http://cgd.io
-Tags: LDAP, authentication, login, active directory, adLDAP
-Requires at least: 3.4
-Tested up to: 4.5.0
-Stable tag: 1.6.0
-License: GPLv2 or later
-
-Integrating WordPress with LDAP shouldn't be difficult. Now it isn't. Simple LDAP Login provides all of the features, none of the hassles.
-
-== Description ==
-Having a single login for every service is a must in large organizations. This plugin allows you to integrate WordPress with LDAP quickly and easily. Like, really really easy.
-
-**Contributing**
-This is a community project now. Most development is done by users like you who find bugs and fix them, or find new ways to make the plugin more powerful for everyone.
-
-The easiest way to contribute to this plugin is to submit a GitHub pull request. Here's the repo:
-https://github.com/clifgriffin/simple-ldap-login
-
-**Support**
-
-If you need support, file an issue here:
-https://github.com/clifgriffin/simple-ldap-login/issues
-
-**Special Requests**
-
-If you need a customization or change specific to your install, I am available for hire. Shoot me an e-mail: clifgriffin[at]gmail.com
-
-= Features =
-
-* Supports Active Directory and OpenLDAP (and other directory systems which comply to the LDAP standard, such as OpenDS)
-* Supports TLS
-* Uses up-to-date methods for WordPress authentication routines.
-* Authenticates existing WordPress usernames against LDAP.
-* Can be configured to automatically create WordPress users for valid LDAP logins.
-* You can restrict logins based on one or more LDAP groups.
-* Intuitive control panel.
-
-= Architecture =
-Simple LDAP Login adds an authentication filter to WordPress that authentication requests must pass. In doing so, it makes several decisions.
-
-* Can the provided credentials be authenticated against LDAP?
-* * If so, is the LDAP user a member of the required LDAP groups (if any)?
-* * * Does a matching WordPress user exist?
-* * * * If so, log the user in.
-* * * * If not, is user creation enabled?
-* * * * * Create the user and log them in.
-
-This is high level overview. This should answer the philosophical questions about how the plugin works. If the plugin is unable to authenticate the user, it should pass it down the chain to WordPress. (Unless LDAP Exclusive is turned on, in which case it won't.)
-
-
-== Changelog ==
-**Version 1.6.0**
-
-* New filter sll_remove_default_authentication_hook lets you override local password fallback.
-* Lots of new features from various pull requests from contributing users. Most of these focus on new settings for edge cases, and some general improvements.
-* If we did our jobs right, nothing will break. But if it does, rolling back to 1.5.5 is the best place to start.
-
-**Version 1.5.5**
-
-* Fix syntax error.
-* Don’t sanitize user info.
-
-**Version 1.5.4**
-
-* Local admins will always fall back to local WP password.
-* Fixes bug where new users do not have name or other information from LDAP directory
-
-**Version 1.5.3**
-
-* Fixing apparent security problem with blank passwords. (!)
-* Fixing typo in filter name (did not affect any functionality)
-* Local admin exception coming soon, as well as more bug fixes.
-* Possible fix for login error upon arriving at login page when LDAP exclusive enabled.
-
-**Version 1.5.2**
-
-* Fixed bug with groups setting.
-* Removed delete_option references in upgrade code to allow for easier rollbacks (sorry about that!)
-* Fixed a few bugs in the user creation code.
-* Fixed bug with storing default user role.
-
-**Version 1.5.1**
-
-* Fixed a bug where the domain controllers are passed as a string.
-
-**Version 1.5**
-
-* Complete rewritten from the ground up.
-* It's Object Oriented, DRY and Singleton.
-* The options have been overhauled to make configuration much easier. Focuses on individual features rather than "modes" that encapsulate several behaviors.
-* Admin pages now use WordPress admin styles and behaviors.
-* Tested with Active Directory. I recommend OpenLDAP users test carefully before implementing in their production environments.
-* Added global on off switch so you can easily disable LDAP authentication without deactivating.
-
-**Version 1.4.0.5.1**
-
-* I broke it. Sorry guys! :(
-* Downgraded adLDAP as some referenced functions no longer exist.
-
-**Version 1.4.0.5**
-
-* Updated adLDAP to version 4.x
-* Fixed error in OpenLDAP group membership check
-* As always TEST this first. Don't assume it works...I don't have a testing environment to ensure it will work correctly.
-
-**Version 1.4.0.4**
-
-* Fixes nickname bug accidentally put back in in last version. (My bad!)
-
-**Version 1.4.0.3**
-* Reverts bug introduced in 1.4.0.2
-* If you installed 1.4.0.2 and use OpenLDAP, please update as soon as possible and verify users cannot login with incorrect passwords (and vice versa).
-
-**Version 1.4.0.2 - Patches submitted by Jonas Genannt and Ilya Kozlov**
-* Updates adLDAP to 3.3.2
-* Fixes issue with users in recursive OUs not being found.
-* Fixes issues with different Base DN formats.
-* NOTE: Please be catious in updating. As I don't have an OpenLDAP install, I am unable to independently confirm these fix the problems. If you have issues, revert to 1.4.0.1 and e-mail me: clifgriffin[at]gmail.com.  Likewise, If you can confirm these changes are effective, also let me know. :)
-
-**Version 1.4.0.1**
-
-* Fix for e-mail exists issue with WP 3.0+ for LDAP installations that don't populate the e-mail address attribute.
-* Shows actual error message from WordPress upon failure.
-
-**Version 1.4**
-
-* First update in about a year. Thanks for your patience.
-* Completely rewritten to support changes in WordPress 2.8+.  Now fully supports WordPress 3.0.
-* Much more manageable and efficient code structure. Less code repetition.
-* Includes TLS support.
-* Allows OpenLDAP users to specify an alternate LDAP attribute to use for logins for those not using UID.
-
-**Version 1.3.0.3**
-
-* Test form now implements wp_authenticate and uses the same routines as the actual login. This also means account creation and group membership are tested.
-* Implemented stripslashes() to correct issue with some special characters such as a single quote and backslash.
-* WordPress account "admin" is now allowed to login using local password even when security mode is set to high. For safety.
-* Made some minor wording changes to the admin panel.
-
-**Version 1.3.0.2.1**
-
-* Fixed case sensitivity issue that could result in multiple accounts. There may be lingering case insensitivity issues due to the get_userdatabylogin function being case-sensitive. We'll figure this out in due time.
-* Sorry for posting two updates on the same day!
-
-**Version 1.3.0.2**
-
-* Fixes several tickets including role assignment, case sensitivity, and potential compatibility issues with other themes/plugins.
-* Added security mode setting to allow security to be tightened.
-* Changed auto created accounts to use a random password rather than the LDAP password given.
-* Fixed error with the way announcements are displayed in the admin panel.
-* More code clean up.
-
-**Version 1.3.0.1**
-
-* Never officially released.
-* Contained code cleanup and some attempted fixes.
-
-**Version 1.3 Beta**
-
-* Support for both Active Directory and OpenLDAP.
-* The ability to create WordPress users automatically upon login based on LDAP group membership OR by LDAP authentication alone.
-* The ability to test domain settings straight from admin panel.
-* Announcements pane that allows me to update you with fixes, cautions, new beta versions, or other important information.
-
-**Version 1.2.0.1**
-
-* Changed required user level for admin page to 10, Administrators only.
-
-**Version 1.2**
-
-* Implemented multiple domain controllers.
-* Changed field sizes on admin page to be more user friendly.
-
-**Version 1.1**
-
-* Moved settings to administration pages under settings.
-* Upgraded to latest version of adLDAP 2.1.
-* Got rid of credentials. (They are not neccessary for the authenticate function in adLDAP!)
-* Plugin is now upgrade proof. Settings are stored using WordPress's setting functions.
-
-**Version 1.0**
-
-* Original release.
-
-== Installation ==
-
-1. Use the WordPress plugin directory to install the plugin or upload the directory `simple-ldap-login` to the `/wp-content/plugins/` directory.
-1. Activate the plugin through the 'Plugins' menu in WordPress
-1. Update the settings to those that best match your environment by going to Settings -> Simple LDAP Login
-1. If you don't get the settings right the first time, don't fret! Just use your WordPress credentials. They should always work
-1. Once you have the settings correct, you can toggle LDAP Exclusive mode (if you like).
-1. To make your life easier, consider using two different browsers (e.g., Chrome and Firefox) to do testing.  Change settings in one. Test in the other. This will prevent any chance of being locked out.
-
-== Frequently Asked Questions ==
-
-= Other than WordPress, what does my system require? =
-
-Your install of PHP must be configured/compiled with LDAP support.
-
-= How do I know what the correct settings are? =
-
-I have tried to make the settings as self-explanatory as possible. If you are struggling figuring them out, you may need to speak with your LDAP administrator. I realize this is an obnoxious response, but there is no good, fool proof way to help you discover these settings. A good place to start, if you're feeling daring, might be to use ADSIEdit for Windows and Active Directory, or GQ for Linux and OpenLDAP.
-
-= It's still not working, what other things can I try? =
-
-If you are confident your settings are correct and it still does not work, it may be time to check for port or firewall issues. If your LDAP server is running on a non-standard port or an obsolete version of the LDAP protocol you are going to have issues. Port 389 is the port this plugin, and nearly every other LDAP enabled software expects. They are also expecting protocol version 3. If you are using an old version of LDAP or running a non-standard port you may need to modify the code that the plugin runs or update your LDAP installation.
-
-Unfortunately I can't be relied upon to assist with these types of requests. I chose not to support these scenarios because they are infrequent and because they confuse everyone else.
-
-= It's still not working! How can I get help? =
-The easiest way to get help is to post a comment on my blog: http://clifgriffin.com/simple-ldap-login/. I'll do my best to get you up and running!
-
-== Screenshots ==
-
-1. Easy to use admin panel.
-2. Advanced options for power users.