![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
summary | shortlog | log | commit | commitdiff | tree
raw | patch | inline | side by side (parent: 0e66a6e)
raw | patch | inline | side by side (parent: 0e66a6e)
| author | cajus <cajus@594d385d-05f5-0310-b6e9-bd551577e9d8> | |
| Fri, 29 Jan 2010 08:19:20 +0000 (08:19 +0000) | ||
| committer | cajus <cajus@594d385d-05f5-0310-b6e9-bd551577e9d8> | |
| Fri, 29 Jan 2010 08:19:20 +0000 (08:19 +0000) |
git-svn-id: https://oss.gonicus.de/repositories/gosa/trunk@15440 594d385d-05f5-0310-b6e9-bd551577e9d8
index b74463f09c95b18cf4d461b81f67d2fab3d6b4a2..3ed4929fabed7195408d9850417264093272ab18 100644 (file)
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
+/*! \brief ACL management plugin */
class acl extends plugin
{
/* Definitions */
index 952e8ec3870953e1bb50296ee5d21ac1d299400c..0f108c4d22789e88a3ebfb43b9a37098443411bc 100644 (file)
}
- /*! \brief execute plugin
-
- Generates the html output for this node
+ /*! \brief Generates the html output for this node
*/
function execute()
{
session::set('LOCK_VARS_USED_REQUEST',array());
}
- /*! \brief execute plugin
- Removes object from parent
+ /*! \brief Removes object from parent
*/
function remove_from_parent()
{
}
- /*! \brief Save HTML posted data to object
+ /*! \brief Save HTML posted data to object
*/
function save_object()
{
}
- /* Save data to LDAP, depending on is_account we save or delete */
+ /*! \brief Save data to LDAP, depending on is_account we save or delete */
function save()
{
/* include global link_info */
}
}
- /* Check formular input */
+ /*! \brief Check formular input */
function check()
{
$message= array();
}
}
- /* Indicate whether a password change is needed or not */
+ /* \brief Indicate whether a password change is needed or not */
function password_change_needed()
{
return FALSE;
}
- /* Show header message for tab dialogs */
+ /*! \brief Show header message for tab dialogs */
function show_enable_header($button_text, $text, $disabled= FALSE)
{
if (($disabled == TRUE) || (!$this->acl_is_createable())){
}
- /* Show header message for tab dialogs */
+ /*! \brief Show header message for tab dialogs */
function show_disable_header($button_text, $text, $disabled= FALSE)
{
if (($disabled == TRUE) || !$this->acl_is_removeable()){
}
- /* Show header message for tab dialogs */
+ /*! \brief Show header message for tab dialogs */
function show_header($button_text, $text, $disabled= FALSE)
{
echo "FIXME: show_header should be replaced by show_disable_header and show_enable_header<br>";
return($display);
}
-
+ /*! \brief Executes commands after an object has been created */
function postcreate($add_attrs= array())
{
/* Find postcreate entries for this class */
}
}
+ /*! \brief Execute commands after an object has been modified */
function postmodify($add_attrs= array())
{
/* Find postcreate entries for this class */
}
}
+ /*! \brief Executes a command after an object has been removed */
function postremove($add_attrs= array())
{
/* Find postremove entries for this class */
}
- /* Create unique DN */
+ /*! \brief Create unique DN */
function create_unique_dn($attribute, $base)
{
$ldap= $this->config->get_ldap_link();
- /*! \brief Move a given ldap object indentified by $src_dn \
- to the given destination $dst_dn \
- * Ensure that all references are updated (ogroups) \
- * Update ACLs \
- * Update accessTo \
- @param String The source dn.
- @param String The destination dn.
- @return Boolean TRUE on success else FALSE.
+ /*! \brief Rename/Move a given src_dn to the given dest_dn
+ *
+ * Move a given ldap object indentified by $src_dn to the
+ * given destination $dst_dn
+ *
+ * - Ensure that all references are updated (ogroups)
+ * - Update ACLs
+ * - Update accessTo
+ *
+ * \param string 'src_dn' the source DN.
+ * \param string 'dst_dn' the destination DN.
+ * \return boolean TRUE on success else FALSE.
*/
function rename($src_dn, $dst_dn)
{
}
-
+
function move($src_dn, $dst_dn)
{
/* Do not copy if only upper- lowercase has changed */
}
- /* Move/Rename complete trees */
+ /* \brief Move/Rename complete trees */
function recursive_move($src_dn, $dst_dn)
{
/* Check if the destination entry exists */
}
+ /*! \brief Prepare for Copy & Paste */
function PrepareForCopyPaste($source)
{
$todo = $this->attributes;
function tag_attrs(&$at, $dn= "", $tag= "", $show= false)
{
/* Skip tagging?
+ /*! \brief Get gosaUnitTag for the given DN */
If this is called from departmentGeneric, we have to skip this
tagging procedure.
*/
}
}
}
-
+
+ /*! \brief Add unit tag */
/* Remove tags that may already be here... */
remove_objectClass("gosaAdministrativeUnitTag", $at);
if (isset($at['gosaUnitTag'])){
}
- /* Add possibility to stop remove process */
+ /*! \brief Test for removability of the object
+ *
+ * Allows testing of conditions for removal of object. If removal should be aborted
+ * the function needs to remove an error message.
+ * */
function allow_remove()
{
$reason= "";
}
- /* Create a snapshot of the current object */
+ /*! \brief Create a snapshot of the current object */
function create_snapshot($type= "snapshot", $description= array())
{
}
}
+ /*! \brief Remove a snapshot */
function remove_snapshot($dn)
{
$ui = get_userinfo();
}
- /* returns true if snapshots are enabled, and false if it is disalbed
- There will also be some errors psoted, if the configuration failed */
+ /*! \brief Test if snapshotting is enabled
+ *
+ * Test weither snapshotting is enabled or not. There will also be some errors posted,
+ * if the configuration failed
+ * \return TRUE if snapshots are enabled, and FALSE if it is disabled
+ */
function snapshotEnabled()
{
return $this->config->snapshotEnabled();
}
- /* Return available snapshots for the given base
- */
+ /* \brief Return available snapshots for the given base */
function Available_SnapsShots($dn,$raw = false)
{
if(!$this->snapshotEnabled()) return(array());
}
- /* Restore selected snapshot */
+ /* \brief Restore selected snapshot */
function restore_snapshot($dn)
{
if(!$this->snapshotEnabled()) return(array());
}
+ /*! \brief Return plugin informations for acl handling */
static function plInfo()
{
return array();
}
- /*! \brief Returns a list of all available departments for this object.
- If this object is new, all departments we are allowed to create a new user in are returned.
- If this is an existing object, return all deps. we are allowed to move tis object too.
-
- @return Array [dn] => "..name" // All deps. we are allowed to act on.
+ /*! \brief Returns a list of all available departments for this object.
+ *
+ * If this object is new, all departments we are allowed to create a new user in
+ * are returned. If this is an existing object, return all deps.
+ * We are allowed to move tis object too.
+ * \return array [dn] => "..name" // All deps. we are allowed to act on.
*/
function get_allowed_bases()
{
/* This function updates ACL settings if $old_dn was used.
- * $old_dn specifies the actually used dn
- * $new_dn specifies the destiantion dn
+ * \param string 'old_dn' specifies the actually used dn
+ * \param string 'new_dn' specifies the destiantion dn
*/
function update_acls($old_dn,$new_dn,$output_changes = FALSE)
{
- /* This function enables the entry Serial ID check.
- * If an entry was edited while we have edited the entry too,
- * an error message will be shown.
+ /*! \brief Enable the Serial ID check
+ *
+ * This function enables the entry Serial ID check. If an entry was edited while
+ * we have edited the entry too, an error message will be shown.
* To configure this check correctly read the FAQ.
*/
function enable_CSN_check()
/*! \brief Prepares the plugin to be used for multiple edit
* Update plugin attributes with given array of attribtues.
- * @param array Array with attributes that must be updated.
+ * \param array Array with attributes that must be updated.
*/
function init_multiple_support($attrs,$all)
{
/*! \brief Returns all values that have been modfied in multiple edit mode.
- @return array Cotaining all mdofied values.
+ \return array Cotaining all modified values.
*/
function get_multi_edit_values()
{
}
- /*! \brief execute plugin
-
- Generates the html output for this node
- */
+ /*! \brief Generates the html output for this node for multi edit*/
function multiple_execute()
{
/* This one is empty currently. Fabian - please fill in the docu code */
}
- /*! \brief Save HTML posted data to object for multiple edit
+ /*! \brief Save HTML posted data to object for multiple edit
*/
function multiple_save_object()
{
}
- /*! \brief Returns all attributes of this plugin,
+ /*! \brief Returns all attributes of this plugin,
to be able to detect multiple used attributes
in multi_plugg::detect_multiple_used_attributes().
@return array Attributes required for intialization of multi_plug
/*! \brief Check given values in multiple edit
- @return array Error messages
+ \return array Error messages
*/
function multiple_check()
{
/*! \brief Returns the snapshot header part for "Actions" menu in management dialogs
- @param $layer_menu
+ \param $layer_menu
*/
function get_snapshot_header($base,$category)
{
index 5309dfa54687a5d4011496613074ca8443b05300..025baf58e2fa5e66a0f29560c0f0786ece99993c 100644 (file)
define ("LDAP_SEARCH", 5);
define ("LDAP_AUTH", 6);
+/*! \brief Some common needed messages */
class msgPool
{
index b7f1c1f0fa8db297f1a46d31b24de3b0ba4c77e9..2073d4973680e8583168a68d7930ac1d4ec263eb 100644 (file)
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
+/*! \brief Test functions
+ *
+ * This class provides various test functions. It enables to check
+ * if a given value is:
+ *
+ * - a phone numnber
+ * - a DNS name
+ * - an URL
+ * etc.
+ *
+ * The functions need to be handled with care, because they are not as strict
+ * as one might expect.
+ */
class tests {
+
+ /*! \brief Test if the given string is a phone number */
public static function is_phone_nr($nr)
{
if ($nr == ""){
}
+ /*! \brief Test if the given string contains characters allowed in a DNS name */
public static function is_dns_name($str)
{
return(preg_match("/^[a-z0-9\.\-_]*$/i",$str));
}
+ /*! \brief Test if the given string is an URL */
public static function is_url($url)
{
if ($url == ""){
}
+ /*! \brief Test if the given string is a DN */
public static function is_dn($dn)
{
if ($dn == ""){
}
+ /*! \brief Test if the given string is an uid */
public static function is_uid($uid)
{
if ($uid == ""){
}
+ /*! \brief Test if the given string is an IP */
public static function is_ip($ip)
{
if(function_exists('filter_var')) {
}
+ /*! \brief Test if the given string is a mac address */
public static function is_mac($mac)
{
return preg_match("/^[a-f0-9][a-f0-9]:[a-f0-9][a-f0-9]:[a-f0-9][a-f0-9]:[a-f0-9][a-f0-9]:[a-f0-9][a-f0-9]:[a-f0-9][a-f0-9]$/i", $mac);
}
- /* Checks if the given ip address dosen't match
+ /*! \brief Checks if the given ip address dosen't match
"is_ip" because there is also a sub net mask given */
public static function is_ip_with_subnetmask($ip)
{
}
- /* Simple is domain check, it checks if the given string looks like "string(...).string" */
+ /*! \brief Simple is domain check
+ *
+ * This checks if the given string looks like "string(...).string"
+ */
public static function is_domain($str)
{
return(preg_match("/^(([a-z0-9\-]{2,63})\.)*[a-z]{2,63}$/i",$str));
}
+ /*! \brief Check if the given argument is an id */
public static function is_id($id)
{
if ($id == ""){
}
+ /*! \brief Check if the given argument is a path */
public static function is_path($path)
{
if ($path == ""){
}
+ /*! \brief Check if the given argument is an email */
public static function is_email($address, $template= FALSE)
{
if ($address == ""){
}
- /* Check if the given department name is valid */
+ /* \brief Check if the given department name is valid */
public static function is_department_name_reserved($name,$base)
{
$reservedName = array("systems","apps","incomming","internal","accounts","fax","addressbook",
}
- /* Check if $ip1 and $ip2 represents a valid IP range
- * returns TRUE in case of a valid range, FALSE in case of an error.
+ /* \brief Check if $ip1 and $ip2 represents a valid IP range
+ * \return TRUE in case of a valid range, FALSE in case of an error.
*/
public static function is_ip_range($ip1,$ip2)
{
}
- /* Check if the specified IP address $address is inside the given network */
+ /* \brief Check if the specified IP address $address is inside the given network */
public static function is_in_network($network, $netmask, $address)
{
$nw= explode('.', $network);
return checkdate($matches[2],$matches[1],$matches[3]);
}
- /* Check if the specified IP address $address is inside the given network */
+ /* \brief Check if the specified IP address $address is inside the given network */
public static function is_in_ip_range($from, $to, $address)
{
$from = explode('.', $from);