Hooks

bzubi · Aug '20

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 · Aug '20

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 · Aug '20

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 · Aug '20

‘session-created’ did the job, thanks.

Topic	Category	Replies	Views	Activity
Can anyone guide me with EGroupware Custom Module Development?	Developers	1	416	Jun '24
How to create InfoLog to EGroupware via API?	Developers	7	121	1d
File to parse time string error	Developers	5	81	2d
Bug Report: JSON PUT for calendar returns 500 when using ISO 8601 or timestamp format for `start`	Developers	3	37	2d

Hooks

created

last reply

replies

views

users

links

Suggested Topics

Want to read more? Browse other topics in Developers or view latest topics.

Hooks

created

last reply

replies

views

users

links

Suggested Topics

Want to read more? Browse other topics in Developers or view latest topics.

share a link to this topic