aboutsummaryrefslogtreecommitdiffstats
path: root/include/security.php
blob: 4643de1059349ab4c59f77fe94da0a75a1b94f87 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
<?php
/**
 * @file include/security.php
 *
 * @brief Some security related functions.
 */

/**
 * @param int $user_record The account_id
 * @param array $channel
 * @param bool $login_initial default false
 * @param bool $interactive default false
 * @param bool $return
 * @param bool $update_lastlog
 */
function authenticate_success($user_record, $channel = null, $login_initial = false, $interactive = false, $return = false, $update_lastlog = false) {

	$_SESSION['addr'] = $_SERVER['REMOTE_ADDR'];

	$lastlog_updated = false;
	$uid_to_load = null;

	if (x($user_record, 'account_id')) {
		App::$account = $user_record;
		$_SESSION['account_id'] = $user_record['account_id'];
		$_SESSION['authenticated'] = 1;

		if ($channel)
			$uid_to_load = $channel['channel_id'];

		if (!$uid_to_load) {
			$uid_to_load = (((x($_SESSION, 'uid')) && (intval($_SESSION['uid'])))
				? intval($_SESSION['uid'])
				: intval(App::$account['account_default_channel'])
			);
		}

		if ($uid_to_load) {
			change_channel($uid_to_load);
		}

		if ($login_initial || $update_lastlog) {
			q("update account set account_lastlog = '%s' where account_id = %d",
				dbesc(datetime_convert()),
				intval($_SESSION['account_id'])
			);
			App::$account['account_lastlog'] = datetime_convert();
			$lastlog_updated = true;
			call_hooks('logged_in', App::$account);
		}

	}

	if (($login_initial) && (!$lastlog_updated)) {

		call_hooks('logged_in', $user_record);

		// might want to log success here
	}

	if ($return || x($_SESSION, 'workflow')) {
		unset($_SESSION['workflow']);
		return;
	}

	if ((App::$module !== 'home') && x($_SESSION, 'login_return_url') && strlen($_SESSION['login_return_url'])) {
		$return_url = $_SESSION['login_return_url'];

		// don't let members get redirected to a raw ajax page update - this can happen
		// if DHCP changes the IP address at an unfortunate time and paranoia is turned on
		if (strstr($return_url, 'update_'))
			$return_url = '';

		unset($_SESSION['login_return_url']);
		goaway(z_root() . '/' . $return_url);
	}

	/* This account has never created a channel. Send them to new_channel by default */

	if (App::$module === 'login') {
		$r = q("select count(channel_id) as total from channel where channel_account_id = %d and channel_removed = 0 ",
			intval(App::$account['account_id'])
		);
		if (($r) && (!$r[0]['total']))
			goaway(z_root() . '/new_channel');
	}

	/* else just return */
}

function atoken_login($atoken) {
	if (!$atoken)
		return false;

	$_SESSION['authenticated'] = 1;
	$_SESSION['visitor_id'] = $atoken['xchan_hash'];
	$_SESSION['atoken'] = $atoken['atoken_id'];

	App::set_observer($atoken);

	return true;
}

/**
 * @brief
 *
 * @param array $atoken
 * @return array|null
 */
function atoken_xchan($atoken) {

	$c = channelx_by_n($atoken['atoken_uid']);
	if ($c) {
		return [
			'atoken_id' => $atoken['atoken_id'],
			'xchan_hash' => substr($c['channel_hash'], 0, 16) . '.' . $atoken['atoken_name'],
			'xchan_name' => $atoken['atoken_name'],
			'xchan_addr' => 'guest:' . $atoken['atoken_name'] . '@' . App::get_hostname(),
			'xchan_network' => 'unknown',
			'xchan_url' => z_root() . '/guest/' . substr($c['channel_hash'], 0, 16) . '.' . $atoken['atoken_name'],
			'xchan_hidden' => 1,
			'xchan_photo_mimetype' => 'image/png',
			'xchan_photo_l' => z_root() . '/' . get_default_profile_photo(300),
			'xchan_photo_m' => z_root() . '/' . get_default_profile_photo(80),
			'xchan_photo_s' => z_root() . '/' . get_default_profile_photo(48)
		];
	}

	return null;
}

function atoken_delete($atoken_id) {

	$r = q("select * from atoken where atoken_id = %d",
		intval($atoken_id)
	);
	if (!$r)
		return;

	$c = q("select channel_id, channel_hash from channel where channel_id = %d",
		intval($r[0]['atoken_uid'])
	);
	if (!$c)
		return;

	$atoken_xchan = substr($c[0]['channel_hash'], 0, 16) . '.' . $r[0]['atoken_name'];

	q("delete from atoken where atoken_id = %d",
		intval($atoken_id)
	);
	q("delete from abconfig where chan = %d and xchan = '%s'",
		intval($c[0]['channel_id']),
		dbesc($atoken_xchan)
	);
}

/**
 * @brief
 *
 * In order for atoken logins to create content (such as posts) they need a stored xchan.
 * we'll create one on the first atoken_login; it can't really ever go away but perhaps
 * @fixme we should set xchan_deleted if it's expired or removed
 *
 * @param array $xchan
 * @return void|boolean
 */
function atoken_create_xchan($xchan) {

	$r = q("select xchan_hash from xchan where xchan_hash = '%s'",
		dbesc($xchan['xchan_hash'])
	);
	if ($r)
		return;

	$xchan['xchan_guid'] = $xchan['xchan_hash'];

	$store = [];
	foreach ($xchan as $k => $v) {
		if (strpos($k, 'xchan_') === 0) {
			$store[$k] = $v;
		}
	}

	xchan_store_lowlevel($store);

	return true;
}

function atoken_abook($uid, $xchan_hash) {

	if (substr($xchan_hash, 16, 1) != '.')
		return false;

	$r = q("select channel_hash from channel where channel_id = %d limit 1",
		intval($uid)
	);

	if (!$r)
		return false;

	$x = q("select * from atoken where atoken_uid = %d and atoken_name = '%s'",
		intval($uid),
		dbesc(substr($xchan_hash, 17))
	);

	if ($x) {
		$xchan = atoken_xchan($x[0]);
		$xchan['abook_blocked'] = 0;
		$xchan['abook_ignored'] = 0;
		$xchan['abook_pending'] = 0;
		return $xchan;
	}

	return false;
}


function pseudo_abook($xchan) {
	if (!$xchan)
		return false;

	// set abook_pseudo to flag that we aren't really connected.

	$xchan['abook_pseudo'] = 1;
	$xchan['abook_blocked'] = 0;
	$xchan['abook_ignored'] = 0;
	$xchan['abook_pending'] = 0;

	return $xchan;
}


/**
 * @brief Change to another channel with current logged-in account.
 *
 * @param int $change_channel The channel_id of the channel you want to change to
 *
 * @return bool|array false or channel record of the new channel
 */
function change_channel($change_channel) {

	$ret = false;

	if ($change_channel) {

		$r = q("select channel.*, xchan.* from channel left join xchan on channel.channel_hash = xchan.xchan_hash where channel_id = %d and channel_account_id = %d and channel_removed = 0 limit 1",
			intval($change_channel),
			intval(get_account_id())
		);

		// It's not there.  Is this an administrator, and is this the sys channel?
		if (is_developer()) {
			if (!$r) {
				if (is_site_admin()) {
					$r = q("select channel.*, xchan.* from channel left join xchan on channel.channel_hash = xchan.xchan_hash where channel_id = %d and channel_system = 1 and channel_removed = 0 limit 1",
						intval($change_channel)
					);
				}
			}
		}

		if ($r) {
			$hash = $r[0]['channel_hash'];
			$_SESSION['uid'] = intval($r[0]['channel_id']);
			App::set_channel($r[0]);
			$_SESSION['theme'] = $r[0]['channel_theme'];
			$_SESSION['mobile_theme'] = get_pconfig(local_channel(), 'system', 'mobile_theme');
			$_SESSION['cloud_tiles'] = get_pconfig(local_channel(), 'system', 'cloud_tiles');
			date_default_timezone_set($r[0]['channel_timezone']);

			// Update the active timestamp at most once a day

			if (substr($r[0]['channel_active'], 0, 10) !== substr(datetime_convert(), 0, 10)) {
				q("UPDATE channel SET channel_active = '%s' WHERE channel_id = %d",
					dbesc(datetime_convert()),
					intval($r[0]['channel_id'])
				);
			}
			$ret = $r[0];
		}
		$x = q("select * from xchan where xchan_hash = '%s' limit 1",
			dbesc($hash)
		);
		if ($x) {
			$_SESSION['my_url'] = $x[0]['xchan_url'];
			$_SESSION['my_address'] = channel_reddress($r[0]);

			App::set_observer($x[0]);
			App::set_perms(get_all_perms(local_channel(), $hash));
		}
		if (!is_dir('store/' . $r[0]['channel_address']))
			@os_mkdir('store/' . $r[0]['channel_address'], STORAGE_DEFAULT_PERMISSIONS, true);

		$arr = ['channel_id' => $change_channel, 'chanx' => $ret];
		call_hooks('change_channel', $arr);
	}

	return $ret;
}

/**
 * @brief Creates an additional SQL where statement to check permissions.
 *
 * @param int $owner_id
 * @param bool $remote_observer (optional) use current observer if unset
 * @param $table (optional)
 *
 * @return string additional SQL where statement
 */

function permissions_sql($owner_id, $remote_observer = null, $table = '') {

	$local_channel = local_channel();

	/**
	 * Construct permissions
	 *
	 * default permissions - anonymous user
	 */

	if ($table)
		$table .= '.';

	$sql = " AND {$table}allow_cid = ''
			 AND {$table}allow_gid = ''
			 AND {$table}deny_cid  = ''
			 AND {$table}deny_gid  = ''
	";

	/**
	 * Profile owner - everything is visible
	 */

	if (($local_channel) && ($local_channel == $owner_id)) {
		return EMPTY_STR;
	}
	/**
	 * Authenticated visitor.
	 */

	else {

		$observer = ((!is_null($remote_observer)) ? $remote_observer : get_observer_hash());

		if ($observer) {

			$sec = get_security_ids($owner_id, $observer);

			// always allow the channel owner, even if authenticated as a visitor

			if ($sec['channel_id']) {
				foreach ($sec['channel_id'] as $ch) {
					if ($observer === $ch) {
						return EMPTY_STR;
					}
				}
			}

			if (is_array($sec['allow_cid']) && count($sec['allow_cid'])) {
				$ca = [];
				foreach ($sec['allow_cid'] as $c) {
					$ca[] = '<' . $c . '>';
				}
				$cs = implode('|', $ca);
			}
			else {
				$cs = '<<>>'; // should be impossible to match
			}

			if (is_array($sec['allow_gid']) && count($sec['allow_gid'])) {
				$ga = [];
				foreach ($sec['allow_gid'] as $g) {
					$ga[] = '<' . $g . '>';
				}
				$gs = implode('|', $ga);
			}
			else {
				$gs = '<<>>'; // should be impossible to match
			}

			$regexop = db_getfunc('REGEXP');
			$sql = sprintf(
				" AND ( NOT ({$table}deny_cid $regexop '%s' OR {$table}deny_gid $regexop '%s')
				  AND ( {$table}allow_cid $regexop '%s' OR {$table}allow_gid $regexop '%s' OR ( {$table}allow_cid = '' AND {$table}allow_gid = '') )
				  )
				",
				dbesc($cs),
				dbesc($gs),
				dbesc($cs),
				dbesc($gs)
			);
		}
	}

	return $sql;
}

/**
 * @brief Creates an additional SQL where statement to check permissions for an item.
 *
 * @param int $owner_id
 * @param bool $remote_observer (optional) use current observer if unset
 *
 * @return string additional SQL where statement
 */

function item_permissions_sql($owner_id, $remote_observer = null) {

	$local_channel = local_channel();

	/**
	 * Construct permissions
	 *
	 * default permissions - anonymous user
	 */

	$sql = " AND item_private = 0 ";

	/**
	 * Profile owner - everything is visible
	 */

	if (($local_channel) && ($local_channel == $owner_id)) {
		$sql = '';
	}
	/**
	 * Authenticated visitor.
	 */

	else {

		$observer = (($remote_observer) ? $remote_observer : get_observer_hash());

		if ($observer) {

			$scope = scopes_sql($owner_id, $observer);
			$sec = get_security_ids($owner_id, $observer);

			// always allow the channel owner, even if authenticated as a visitor

			if ($sec['channel_id']) {
				foreach ($sec['channel_id'] as $ch) {
					if ($observer === $ch) {
						return EMPTY_STR;
					}
				}
			}

			if (is_array($sec['allow_cid']) && count($sec['allow_cid'])) {
				$ca = [];
				foreach ($sec['allow_cid'] as $c) {
					$ca[] = '<' . $c . '>';
				}
				$cs = implode('|', $ca);
			}
			else {
				$cs = '<<>>'; // should be impossible to match
			}

			if (is_array($sec['allow_gid']) && count($sec['allow_gid'])) {
				$ga = [];
				foreach ($sec['allow_gid'] as $g) {
					$ga[] = '<' . $g . '>';
				}
				$gs = implode('|', $ga);
			}
			else {
				$gs = '<<>>'; // should be impossible to match
			}

			$regexop = db_getfunc('REGEXP');
			$sql = sprintf(
				" AND (( NOT (deny_cid $regexop '%s' OR deny_gid $regexop '%s')
				  AND ( allow_cid $regexop '%s' OR allow_gid $regexop '%s' OR ( allow_cid = '' AND allow_gid = '' AND item_private = 0 ))
				  ) OR ( item_private = 1 $scope ))
				",
				dbesc($cs),
				dbesc($gs),
				dbesc($cs),
				dbesc($gs)
			);
		}
	}

	return $sql;
}

/**
 * Remote visitors also need to be checked against the public_scope parameter if item_private is set.
 * This function checks the various permutations of that field for any which apply to this observer.
 *
 */


function scopes_sql($uid, $observer) {
	$str = " and ( public_policy = 'authenticated' ";
	if (!is_foreigner($observer))
		$str .= " or public_policy = 'network: red' ";
	if (local_channel())
		$str .= " or public_policy = 'site: " . App::get_hostname() . "' ";

	$ab = q("select * from abook where abook_xchan = '%s' and abook_channel = %d limit 1",
		dbesc($observer),
		intval($uid)
	);
	if (!$ab)
		return $str . " ) ";
	if ($ab[0]['abook_pending'])
		$str .= " or public_policy = 'any connections' ";
	$str .= " or public_policy = 'contacts' ) ";
	return $str;
}


/**
 * @param string $observer_hash
 *
 * @return string additional SQL where statement
 */

function public_permissions_sql($observer_hash) {

	$owner_id = 0;

	if ($observer_hash) {

		$sec = get_security_ids($owner_id, $observer_hash);

		if (is_array($sec['allow_cid']) && count($sec['allow_cid'])) {
			$ca = [];
			foreach ($sec['allow_cid'] as $c) {
				$ca[] = '<' . $c . '>';
			}
			$cs = implode('|', $ca);
		}
		else {
			$cs = '<<>>'; // should be impossible to match
		}

		if (is_array($sec['allow_gid']) && count($sec['allow_gid'])) {
			$ga = [];
			foreach ($sec['allow_gid'] as $g) {
				$ga[] = '<' . $g . '>';
			}
			$gs = implode('|', $ga);
		}
		else {
			$gs = '<<>>'; // should be impossible to match
		}

		$regexop = db_getfunc('REGEXP');
		$sql = sprintf(
			" AND ( NOT (deny_cid $regexop '%s' OR deny_gid $regexop '%s')
			  AND ( allow_cid $regexop '%s' OR allow_gid $regexop '%s' OR ( allow_cid = '' AND allow_gid = '' AND item_private = 0) )
			  )
			",
			dbesc($cs),
			dbesc($gs),
			dbesc($cs),
			dbesc($gs)
		);
	}
	else {
		$sql = EMPTY_STR;
	}

	return $sql;
}


/*
 * Functions used to protect against Cross-Site Request Forgery
 * The security token has to base on at least one value that an attacker can't know - here it's the session ID and the private key.
 * In this implementation, a security token is reusable (if the user submits a form, goes back and resubmits the form, maybe with small changes;
 * or if the security token is used for ajax-calls that happen several times), but only valid for a certain amout of time (3hours).
 * The "typename" seperates the security tokens of different types of forms. This could be relevant in the following case:
 *	  A security token is used to protect a link from CSRF (e.g. the "delete this profile"-link).
 *    If the new page contains by any chance external elements, then the used security token is exposed by the referrer.
 *    Actually, important actions should not be triggered by Links / GET-Requests at all, but somethimes they still are,
 *    so this mechanism brings in some damage control (the attacker would be able to forge a request to a form of this type, but not to forms of other types).
 */
function get_form_security_token($typename = '') {

	$timestamp = time();
	$sec_hash = hash('whirlpool', App::$observer['xchan_guid'] . ((local_channel()) ? App::$channel['channel_prvkey'] : '') . session_id() . $timestamp . $typename);

	return $timestamp . '.' . $sec_hash;
}

function check_form_security_token($typename = '', $formname = 'form_security_token') {
	if (!x($_REQUEST, $formname)) return false;
	$hash = $_REQUEST[$formname];

	$max_livetime = 10800; // 3 hours
	$min_livetime = 3; // 3 sec

	$x = explode('.', $hash);
	if (time() > (IntVal($x[0]) + $max_livetime) || time() < (IntVal($x[0]) + $min_livetime))
		return false;

	$sec_hash = hash('whirlpool', App::$observer['xchan_guid'] . ((local_channel()) ? App::$channel['channel_prvkey'] : '') . session_id() . $x[0] . $typename);

	return ($sec_hash == $x[1]);
}

function check_form_security_std_err_msg() {
	/** @noinspection PhpToStringImplementationInspection */
	return t('The form security token was not correct. This probably happened because the form has been opened for too long (>3 hours) before submitting it.') . EOL;
}

function check_form_security_token_redirectOnErr($err_redirect, $typename = '', $formname = 'form_security_token') {
	if (!check_form_security_token($typename, $formname)) {
		logger('check_form_security_token failed: user ' . App::$observer['xchan_name'] . ' - form element ' . $typename);
		logger('check_form_security_token failed: _REQUEST data: ' . print_r($_REQUEST, true), LOGGER_DATA);
		notice(check_form_security_std_err_msg());
		goaway(z_root() . $err_redirect);
	}
}

function check_form_security_token_ForbiddenOnErr($typename = '', $formname = 'form_security_token') {
	if (!check_form_security_token($typename, $formname)) {
		logger('check_form_security_token failed: user ' . App::$observer['xchan_name'] . ' - form element ' . $typename);
		logger('check_form_security_token failed: _REQUEST data: ' . print_r($_REQUEST, true), LOGGER_DATA);
		header('HTTP/1.1 403 Forbidden');
		killme();
	}
}


// Returns an array of group hash id's on this entire site (across all channels) that this connection is a member of.
// var $contact_id = xchan_hash of connection

function init_groups_visitor($contact_id) {
	$groups = [];

	$x = q("select * from xchan where xchan_hash = '%s'",
		dbesc($contact_id)
	);

	if (!$x) {
		return $groups;
	}

	// include xchans for all zot-like networks

	$xchans = q("select xchan_hash from xchan where xchan_hash = '%s' OR ( xchan_guid = '%s' AND xchan_pubkey = '%s' ) ",
		dbesc($contact_id),
		dbesc($x[0]['xchan_guid']),
		dbesc($x[0]['xchan_pubkey'])
	);

	if ($xchans) {
		$hashes = ids_to_querystr($xchans, 'xchan_hash', true);
	}

	// private profiles are treated as a virtual group

	$r = q("SELECT abook_profile from abook where abook_xchan in ( " . protect_sprintf($hashes) . " ) and abook_profile != '' ");
	if ($r) {
		foreach ($r as $rv) {
			$groups[] = 'vp.' . $rv['abook_profile'];
		}
	}

	// physical groups this identity is a member of

	$r = q("SELECT hash FROM pgrp left join pgrp_member on pgrp.id = pgrp_member.gid WHERE xchan in ( " . protect_sprintf($hashes) . " ) ");
	if ($r) {
		foreach ($r as $rr)
			$groups[] = $rr['hash'];
	}
	return $groups;
}


function get_security_ids($channel_id, $ob_hash) {

	$ret = [
		'channel_id' => [],
		'allow_cid' => [],
		'allow_gid' => []
	];

	if ($channel_id) {
		$ch = q("select channel_hash, channel_portable_id from channel where channel_id = %d",
			intval($channel_id)
		);
		if ($ch) {
			$ret['channel_id'][] = $ch[0]['channel_hash'];
			$ret['channel_id'][] = $ch[0]['channel_portable_id'];
		}
	}

	$groups = [];

	$x = q("select * from xchan where xchan_hash = '%s'",
		dbesc($ob_hash)
	);

	if ($x) {

		// include xchans for all zot-like networks

		$xchans = q("select xchan_hash from xchan where xchan_hash = '%s' OR ( xchan_guid = '%s' AND xchan_pubkey = '%s' ) ",
			dbesc($ob_hash),
			dbesc($x[0]['xchan_guid']),
			dbesc($x[0]['xchan_pubkey'])
		);

		if ($xchans) {
			$ret['allow_cid'] = ids_to_array($xchans, 'xchan_hash');
			$hashes = ids_to_querystr($xchans, 'xchan_hash', true);

			// private profiles are treated as a virtual group

			$r = q("SELECT abook_profile from abook where abook_xchan in ( " . protect_sprintf($hashes) . " ) and abook_profile != '' ");
			if ($r) {
				foreach ($r as $rv) {
					$groups[] = 'vp.' . $rv['abook_profile'];
				}
			}

			// physical groups this identity is a member of

			$r = q("SELECT hash FROM pgrp left join pgrp_member on pgrp.id = pgrp_member.gid WHERE xchan in ( " . protect_sprintf($hashes) . " ) ");
			if ($r) {
				foreach ($r as $rv) {
					$groups[] = $rv['hash'];
				}
			}
			$ret['allow_gid'] = $groups;
		}
	}

	return $ret;
}


// This is used to determine which uid have posts which are visible to the logged in user (from the API) for the
// public_timeline, and we can use this in a community page by making
// $perms = (PERMS_NETWORK|PERMS_PUBLIC) unless logged in.
// Collect uids of everybody on this site who has opened their posts to everybody on this site (or greater visibility)
// We always include yourself if logged in because you can always see your own posts
// resolving granular permissions for the observer against every person and every post on the site
// will likely be too expensive.
// Returns a string list of comma separated channel_ids suitable for direct inclusion in a SQL query

function stream_perms_api_uids($perms = NULL, $limit = 0, $rand = 0) {
	$perms = is_null($perms) ? (PERMS_SITE | PERMS_NETWORK | PERMS_PUBLIC) : $perms;

	$ret = array();
	$limit_sql = (($limit) ? " LIMIT " . intval($limit) . " " : '');
	$random_sql = (($rand) ? " ORDER BY " . db_getfunc('RAND') . " " : '');
	if (local_channel())
		$ret[] = local_channel();
	$x = q("select uid, v from pconfig where cat = 'perm_limits' and k = 'view_stream' ");
	if ($x) {
		$y = [];
		foreach ($x as $xv) {
			if (intval($xv['v']) & $perms) {
				$y[] = $xv;
			}
		}
		if ($y) {
			$ids = ids_to_querystr($y, 'uid');
			$r = q("select channel_id from channel where channel_id in ( $ids ) and ( channel_pageflags & %d ) = 0 and channel_system = 0 and channel_removed = 0 $random_sql $limit_sql ",
				intval(PAGE_ADULT | PAGE_CENSORED)
			);
			if ($r) {
				foreach ($r as $rr)
					if (!in_array($rr['channel_id'], $ret))
						$ret[] = $rr['channel_id'];
			}
		}
	}

	$str = '';
	if ($ret) {
		foreach ($ret as $rr) {
			if ($str)
				$str .= ',';
			$str .= intval($rr);
		}
	}
	else
		$str = "''";

	logger('stream_perms_api_uids: ' . $str, LOGGER_DEBUG);

	return $str;
}

function stream_perms_xchans($perms = NULL) {
	$perms = is_null($perms) ? (PERMS_SITE | PERMS_NETWORK | PERMS_PUBLIC) : $perms;

	$ret = array();
	if (local_channel())
		$ret[] = get_observer_hash();

	$x = q("select uid, v from pconfig where cat = 'perm_limits' and k = 'view_stream' ");
	if ($x) {
		$y = [];
		foreach ($x as $xv) {
			if (intval($xv['v']) & $perms) {
				$y[] = $xv;
			}
		}
		if ($y) {
			$ids = ids_to_querystr($y, 'uid');

			$r = q("select channel_hash from channel where channel_id in ( $ids ) and ( channel_pageflags & %d ) = 0 and channel_system = 0 and channel_removed = 0 ",
				intval(PAGE_ADULT | PAGE_CENSORED)
			);

			if ($r) {
				foreach ($r as $rr)
					if (!in_array($rr['channel_hash'], $ret))
						$ret[] = $rr['channel_hash'];
			}
		}
	}
	$str = '';
	if ($ret) {
		foreach ($ret as $rr) {
			if ($str)
				$str .= ',';
			$str .= "'" . dbesc($rr) . "'";
		}
	}
	else
		$str = "''";

	logger('stream_perms_xchans: ' . $str, LOGGER_DEBUG);

	return $str;
}


/**
 * Duty day / time checks for account register
 * @author hilmar runge
 * @since  2020.02.10
 * @param  $op what to test: isOpen, nextOpen
 * @param  $wd weekday according ISO-8601 (1 monday, 7 sunday)
 * @param  $hhmm a 24h clock value hours and minutes
 *		   if no params are given, the values are taken from the current time
 *         return is bool(false) if register_duty is not available
 */
function zarIsDuty($wd=NULL, $hhmm=NULL, $op='isOpen') {

	$isduty = get_config('system', 'register_duty_jso');

	if (!$isduty)
		return (bool)false;

	is_null($wd) ? $wd = date('N') : '';
	is_null($hhmm) ? $hhmm = date('Hi') : '';

	if (!intval($wd . $hhmm)) return (bool)false;

	// be sure to have a valid weekday as index
	$wd = (7 + $wd) % 7;
	$wd === 0 ? $wd = 7 : '';

	$duty = json_decode($isduty, true);
	if (!$duty)
		return (bool)false;

	switch ($op) {
		case 'isOpen':
			/**
			 * Check if registration is open
 			 * @return int(0) for not close (open) or int(1) for closed.
			 *         return is bool(false) if register_duty is not available
			 */
			if (!$duty[$wd]) return (bool)false;
			$dutyis = 0;
			foreach ($duty[$wd] as $o => $tf) {
				if ($o > $hhmm) {
					$dutyis = $tf;
					break;
				}
			}
			return $dutyis;
			break;

		case 'nextOpen':
			/**
			 * Look for next period opens
			 * @return "=>N =>Hi" date value of the next period register is open for requests
 			 *			where N is a weekday (1=monday ... 7=sunday) according ISO-8601
			 *			where Hi is a 24h clock value hhmm by hours and minutes.
			 *			If no next period open is available, return results to false.
			 */
			$myd = $wd;
			$myh = $hhmm;
			$is1 = false;

			// $myd = "5";		// testcase only
			// $myh = "1110";	// testcase only

			// a 1st match may be applied below my time and is to see as a cycle to the next week
			// but looking is also for a open time after my time is available this week
			foreach ($duty as $dd => $dhs) {

				if ($is1 && $dd < $myd)
					continue;

				foreach ($dhs as $dh => $tf) {

					if ($tf) continue; 	// close

					// a weeks 1st open
					if (!$is1) $is1 = array($dd, $dh);

					// but is a match after now?
					//if ($dd == $myd && $myh >= $dh && $myh <= $dh) continue;

					// if the day is not (more) today start find early morning
					if ($dd > $myd) $myh = "0000";

					// a next period after now in the remainder of the week
					if ($dd >= $myd && $dh >= $myh && !$tf)
						return array($dd, $dh);
					else
						continue;
				}
			}
			return $is1; // false or array
			break;

		default:
			//
			break;
	}

}