From 59ba19c29203ade7d3273e02e639c5b28cc7e6af Mon Sep 17 00:00:00 2001
From: Roland Gruber <post@rolandgruber.de>
Date: Sat, 6 Oct 2012 16:37:36 +0000
Subject: [PATCH] added upload preactions

---
 lam/VERSION                    |  2 +-
 lam/docs/devel/upgrade.htm     | 11 ++++++++++-
 lam/lib/baseModule.inc         | 12 +++++++++++-
 lam/lib/modules.inc            | 26 +++++++++++++++++++++++--
 lam/templates/massDoUpload.php | 35 +++++++++++++++++++++++++---------
 5 files changed, 72 insertions(+), 14 deletions(-)

diff --git a/lam/VERSION b/lam/VERSION
index bd28b9c5..6bd10744 100644
--- a/lam/VERSION
+++ b/lam/VERSION
@@ -1 +1 @@
-3.9
+3.9.1
diff --git a/lam/docs/devel/upgrade.htm b/lam/docs/devel/upgrade.htm
index cb5e4d8c..12757568 100644
--- a/lam/docs/devel/upgrade.htm
+++ b/lam/docs/devel/upgrade.htm
@@ -13,6 +13,7 @@
 
 
 
+
   
   <meta http-equiv="content-type" content="text/html; charset=ISO-8859-15"><title>Upgrade notes</title>
   
@@ -30,7 +31,15 @@ This is a list of API changes for all LAM releases.
 
 <br>
 
-<h2>3.8 -&gt; 3.9</h2>Module interface:<br>
+<h2>3.9 -&gt; 4.0</h2>Module interface:<br>
+<ul>
+  <li>new function: <span style="font-weight: bold;">doUploadPreActions()</span></li>
+  <li>function <span style="font-weight: bold;">doUploadPostActions() </span>contains attributes by reference<span style="font-weight: bold;"><br>
+    </span></li>
+</ul>
+<br>
+<h2>3.8 -&gt; 3.9</h2>
+Module interface:<br>
 
 <ul>
 <li>new function <span style="font-weight: bold;">supportsAdminInterface()</span>: Can be used to mark modules that only support the self service.</li>
diff --git a/lam/lib/baseModule.inc b/lam/lib/baseModule.inc
index 2d55b668..c9563725 100644
--- a/lam/lib/baseModule.inc
+++ b/lam/lib/baseModule.inc
@@ -973,6 +973,16 @@ abstract class baseModule {
 	public function getButtonStatus() {
 		return "enabled";
 	}
+	
+	/**
+	 * Runs any actions that need to be done before an LDAP entry is created.
+	 * 
+	 * @param array $attributes LDAP attributes of this entry (attributes are provided as reference, handle modifications of $attributes with care)
+	 * @return array array which contains status messages. Each entry is an array containing the status message parameters.
+	 */
+	public function doUploadPreActions($attributes) {
+		return array();
+	}
 
 	/**
 	* This function is responsible to do additional tasks after the account has been created in LDAP (e.g. modifying group memberships, adding Quota etc..).
@@ -1036,7 +1046,7 @@ abstract class baseModule {
 	 * The modification is aborted if an error message is returned.
 	 * 
 	 * @param boolean $newAccount new account
-	 * @param array $attributes LDAP attributes of this entry
+	 * @param array $attributes LDAP attributes of this entry (added/modified attributes are provided as reference, handle modifications of $attributes with care)
 	 * @return array array which contains status messages. Each entry is an array containing the status message parameters.
 	 */
 	public function preModifyActions($newAccount, $attributes) {
diff --git a/lam/lib/modules.inc b/lam/lib/modules.inc
index 7746de23..6fde71ac 100644
--- a/lam/lib/modules.inc
+++ b/lam/lib/modules.inc
@@ -490,6 +490,24 @@ function buildUploadAccounts($scope, $data, $ids, $selectedModules) {
 	else return $partialAccounts;
 }
 
+/**
+ * Runs any actions that need to be done before an LDAP entry is created.
+ * 
+ * @param String $scope account type
+ * @param array $selectedModules list of selected account modules
+ * @param array $attributes LDAP attributes of this entry (attributes are provided as reference, handle modifications of $attributes with care)
+ * @return array array which contains status messages. Each entry is an array containing the status message parameters.
+ */
+function doUploadPreActions($scope, $selectedModules, $attributes) {
+	$messages = array();
+	for ($i = 0; $i < sizeof($selectedModules); $i++) {
+		$activeModule = $selectedModules[$i];
+		$module = new $activeModule($scope);
+		$messages = array_merge($messages, $module->doUploadPreActions($attributes));
+	}
+	return $messages;
+}
+
 /**
 * This function executes one post upload action.
 *
@@ -1658,13 +1676,17 @@ class accountContainer {
 				$prePostModifyAttributes = array_merge($prePostModifyAttributes, $attributes[$this->finalDN]['notchanged']);
 			}
 			if (isset($attributes[$this->finalDN]['modify'])) {
-				$prePostModifyAttributes = array_merge($prePostModifyAttributes, $attributes[$this->finalDN]['modify']);
+				foreach ($attributes[$this->finalDN]['modify'] as $key => $value) {
+					$prePostModifyAttributes[$key] = &$attributes[$this->finalDN]['modify'][$key];
+				}
 				foreach ($attributes[$this->finalDN]['modify'] as $key => $value) {
 					$prePostModifyAttributes['MOD.' . $key] = $value;
 				}
 			}
 			if (isset($attributes[$this->finalDN]['add'])) {
-				$prePostModifyAttributes = array_merge($prePostModifyAttributes, $attributes[$this->finalDN]['add']);
+				foreach ($attributes[$this->finalDN]['add'] as $key => $value) {
+					$prePostModifyAttributes[$key] = &$attributes[$this->finalDN]['add'][$key];
+				}
 				foreach ($attributes[$this->finalDN]['add'] as $key => $value) {
 					$prePostModifyAttributes['NEW.' . $key] = $value;
 				}
diff --git a/lam/templates/massDoUpload.php b/lam/templates/massDoUpload.php
index 7954e0e2..e296a1cf 100644
--- a/lam/templates/massDoUpload.php
+++ b/lam/templates/massDoUpload.php
@@ -98,15 +98,32 @@ if (($_SESSION['mass_counter'] < sizeof($accounts)) || !isset($_SESSION['mass_po
 				unset($attrs[$key]);
 			}
 		}
-		$success = @ldap_add($_SESSION['ldap']->server(), $dn, $attrs);
-		if (!$success) {
-			$errorMessage = array(
-				"ERROR",
-				_("LAM was unable to create account %s! An LDAP error occured."),
-				ldap_errno($_SESSION['ldap']->server()) . ": " . ldap_error($_SESSION['ldap']->server()),
-				array($_SESSION['mass_counter']));
-			$_SESSION['mass_errors'][] = $errorMessage;
-			$_SESSION['mass_failed'][] = $_SESSION['mass_counter'];
+		// run preactions
+		$preAttributes = array();
+		foreach ($attrs as $key => $value) {
+			$preAttributes[$key] = &$attrs[$key];
+		}
+		$preAttributes['dn'] = &$dn;
+		$preMessages = doUploadPreActions($scope, $_SESSION['mass_selectedModules'], $preAttributes);
+		$preActionOk = true;
+		for ($i = 0; $i < sizeof($preMessages); $i++) {
+			if (($preMessages[$i][0] == 'ERROR') || ($preMessages[$i][0] == 'WARN')) {
+				$preActionOk = false;
+				$_SESSION['mass_errors'][] = $preMessages[$i];
+			}
+		}
+		if ($preActionOk) {
+			// add LDAP entry
+			$success = @ldap_add($_SESSION['ldap']->server(), $dn, $attrs);
+			if (!$success) {
+				$errorMessage = array(
+					"ERROR",
+					_("LAM was unable to create account %s! An LDAP error occured."),
+					ldap_errno($_SESSION['ldap']->server()) . ": " . ldap_error($_SESSION['ldap']->server()),
+					array($_SESSION['mass_counter']));
+				$_SESSION['mass_errors'][] = $errorMessage;
+				$_SESSION['mass_failed'][] = $_SESSION['mass_counter'];
+			}
 		}
 		$_SESSION['mass_counter']++;
 	}