docs: Fix typos in man vfs_gpfs.
[Samba.git] / source3 / modules / vfs_readonly.c
blob445f947810353b320e1423ef028cc300fb6078b4
1 /*
2 Unix SMB/Netbios implementation.
3 Version 1.9.
4 VFS module to perform read-only limitation based on a time period
5 Copyright (C) Alexander Bokovoy 2003
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>.
20 This work was sponsored by Optifacio Software Services, Inc.
23 #include "includes.h"
24 #include "smbd/smbd.h"
25 #include "getdate.h"
28 This module performs a read-only limitation for specified share
29 (or all of them if it is loaded in a [global] section) based on period
30 definition in smb.conf. You can stack this module multiple times under
31 different names to get multiple limit intervals.
33 The module uses get_date() function from coreutils' date utility to parse
34 specified dates according to date(1) rules. Look into info page for date(1)
35 to understand the syntax.
37 The module accepts one parameter:
39 readonly: period = "begin date","end date"
41 where "begin date" and "end date" are mandatory and should comply with date(1)
42 syntax for date strings.
44 Example:
46 readonly: period = "today 14:00","today 15:00"
48 Default:
50 readonly: period = "today 0:0:0","tomorrow 0:0:0"
52 The default covers whole day thus making the share readonly
56 #define MODULE_NAME "readonly"
57 static int readonly_connect(vfs_handle_struct *handle,
58 const char *service,
59 const char *user)
61 const char *period_def[] = {"today 0:0:0", "tomorrow 0:0:0"};
63 const char **period = lp_parm_string_list(SNUM(handle->conn),
64 (handle->param ? handle->param : MODULE_NAME),
65 "period", period_def);
66 int ret = SMB_VFS_NEXT_CONNECT(handle, service, user);
68 if (ret < 0) {
69 return ret;
72 if (period && period[0] && period[1]) {
73 int i;
74 time_t current_time = time(NULL);
75 time_t begin_period = get_date(period[0], &current_time);
76 time_t end_period = get_date(period[1], &current_time);
78 if ((current_time >= begin_period) && (current_time <= end_period)) {
79 connection_struct *conn = handle->conn;
81 handle->conn->read_only = True;
83 /* Wipe out the VUID cache. */
84 for (i=0; i< VUID_CACHE_SIZE; i++) {
85 struct vuid_cache_entry *ent = &conn->vuid_cache->array[i];
86 ent->vuid = UID_FIELD_INVALID;
87 TALLOC_FREE(ent->session_info);
88 ent->read_only = false;
89 ent->share_access = 0;
91 conn->vuid_cache->next_entry = 0;
94 return 0;
96 } else {
98 return 0;
104 static struct vfs_fn_pointers vfs_readonly_fns = {
105 .connect_fn = readonly_connect
108 NTSTATUS vfs_readonly_init(void);
109 NTSTATUS vfs_readonly_init(void)
111 return smb_register_vfs(SMB_VFS_INTERFACE_VERSION, MODULE_NAME,
112 &vfs_readonly_fns);