Hooks

bzubi 2020-08-11 07:59:42 UTC #1

Greetings,

is there an overview of which hooks exist and when they are pulled?
if i want to do something on every login, is ‘addaccount’ the only hook for this?
on what existing app i should orientate me, how hooks should be implemented?

Thomas

RalfBecker 2020-08-11 08:29:26 UTC #2

Hi Thomas,

addaccount is called when a new account is created, NOT at login.

session_creation is called during login and can reject the login by throwing an exception, but is does NOT yet have a complete user environment:

github.com

EGroupware/egroupware/blob/master/api/src/Session.php#L618


			if ($GLOBALS['egw']->acl->check('anonymous',1,'phpgwapi'))
			{
				$this->session_flags = 'A';
			}
			else
			{
				$this->session_flags = 'N';
			}


			if (($hook_result = Hooks::process(array(
				'location'       => 'session_creation',
				'sessionid'      => $this->sessionid,
				'session_flags'  => $this->session_flags,
				'account_id'     => $this->account_id,
				'account_lid'    => $this->account_lid,
				'passwd'         => $this->passwd,
				'account_domain' => $this->account_domain,
				'user_ip'        => $user_ip,
			),'',true)))	// true = run hooks from all apps, not just the ones the current user has perms to run
			{
				foreach($hook_result as $reason)

session_created is called once the user has successful logged in, before redirecting to the regular UI. It is also called for non-interactive logins like CalDAV/CardDAV!

github.com

EGroupware/egroupware/blob/master/api/src/Session.php#L678


				{
					self::egw_setcookie(self::REMEMBER_ME_COOKIE, $token, $expiration);
				}


				if (self::ERROR_LOG_DEBUG) error_log(__METHOD__ . "($this->login,$this->passwd,$this->passwd_type,$no_session,$auth_check) successfull sessionid=$this->sessionid");
			}
			elseif (self::ERROR_LOG_DEBUG) error_log(__METHOD__ . "($this->login,$this->passwd,$this->passwd_type,$no_session,$auth_check) could NOT set session cookies, headers already sent");


			// hook called once session is created
			Hooks::process(array(
				'location'       => 'session_created',
				'sessionid'      => $this->sessionid,
				'session_flags'  => $this->session_flags,
				'account_id'     => $this->account_id,
				'account_lid'    => $this->account_lid,
				'passwd'         => $this->passwd,
				'account_domain' => $this->account_domain,
				'user_ip'        => $user_ip,
				'session_type'   => Session\Type::get($_SERVER['REQUEST_URI'],
					$GLOBALS['egw_info']['flags']['current_app'],
					true),	// true return WebGUI instead of login, as we are logged in now

The Framework has a couple of hooks, only called for interactive usage, but also if the user reloads with F5.

Can you be a bit more specific what you want to archive.

Ralf

bzubi 2020-08-11 08:39:32 UTC #3

well, ive build my app, where i retreive userdata, like phone, mobile, room number, and so on, from active directory and merge it with the exisiting contact in sql - for the current user.
But I dont want the user to click an app for a contactupdate, it should happen automatically.

the options i think of are:

synchronize the data on login for the user (sound more resonable?)
a cronjob and a loop over all users

Thomas

bzubi 2020-08-12 06:57:49 UTC #4

‘session-created’ did the job, thanks.