1/*
2   Unix SMB/CIFS implementation.
3   NBT netbios routines and daemon - version 2
4   Copyright (C) Andrew Tridgell 1994-1998
5   Copyright (C) Luke Kenneth Casson Leighton 1994-1998
6   Copyright (C) Jeremy Allison 1994-1998
7
8   This program is free software; you can redistribute it and/or modify
9   it under the terms of the GNU General Public License as published by
10   the Free Software Foundation; either version 2 of the License, or
11   (at your option) any later version.
12
13   This program is distributed in the hope that it will be useful,
14   but WITHOUT ANY WARRANTY; without even the implied warranty of
15   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16   GNU General Public License for more details.
17
18   You should have received a copy of the GNU General Public License
19   along with this program; if not, write to the Free Software
20   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21
22*/
23
24#include "includes.h"
25
26extern uint16 samba_nb_type;
27
28int workgroup_count = 0; /* unique index key: one for each workgroup */
29
30/****************************************************************************
31  Add a workgroup into the list.
32**************************************************************************/
33
34static void add_workgroup(struct subnet_record *subrec, struct work_record *work)
35{
36	work->subnet = subrec;
37	DLIST_ADD(subrec->workgrouplist, work);
38	subrec->work_changed = True;
39}
40
41/****************************************************************************
42 Copy name to unstring. Used by create_workgroup() and find_workgroup_on_subnet().
43**************************************************************************/
44
45static void name_to_unstring(unstring unname, const char *name)
46{
47        nstring nname;
48
49	errno = 0;
50	push_ascii_nstring(nname, name);
51	if (errno == E2BIG) {
52		unstring tname;
53		pull_ascii_nstring(tname, sizeof(tname), nname);
54		unstrcpy(unname, tname);
55		DEBUG(0,("name_to_nstring: workgroup name %s is too long. Truncating to %s\n",
56			name, tname));
57	} else {
58		unstrcpy(unname, name);
59	}
60}
61
62/****************************************************************************
63  Create an empty workgroup.
64**************************************************************************/
65
66static struct work_record *create_workgroup(const char *name, int ttl)
67{
68	struct work_record *work;
69	struct subnet_record *subrec;
70	int t = -1;
71
72	if((work = SMB_MALLOC_P(struct work_record)) == NULL) {
73		DEBUG(0,("create_workgroup: malloc fail !\n"));
74		return NULL;
75	}
76	memset((char *)work, '\0', sizeof(*work));
77
78	name_to_unstring(work->work_group, name);
79
80	work->serverlist = NULL;
81
82	work->RunningElection = False;
83	work->ElectionCount = 0;
84	work->announce_interval = 0;
85	work->needelection = False;
86	work->needannounce = True;
87	work->lastannounce_time = time(NULL);
88	work->mst_state = lp_local_master() ? MST_POTENTIAL : MST_NONE;
89	work->dom_state = DOMAIN_NONE;
90	work->log_state = LOGON_NONE;
91
92	work->death_time = (ttl != PERMANENT_TTL) ? time(NULL)+(ttl*3) : PERMANENT_TTL;
93
94	/* Make sure all token representations of workgroups are unique. */
95
96	for (subrec = FIRST_SUBNET; subrec && (t == -1); subrec = NEXT_SUBNET_INCLUDING_UNICAST(subrec)) {
97		struct work_record *w;
98		for (w = subrec->workgrouplist; w && t == -1; w = w->next) {
99			if (strequal(w->work_group, work->work_group))
100				t = w->token;
101		}
102	}
103
104	if (t == -1)
105		work->token = ++workgroup_count;
106	else
107		work->token = t;
108
109	/* No known local master browser as yet. */
110	*work->local_master_browser_name = '\0';
111
112	/* No known domain master browser as yet. */
113	*work->dmb_name.name = '\0';
114	zero_ip(&work->dmb_addr);
115
116	/* WfWg  uses 01040b01 */
117	/* Win95 uses 01041501 */
118	/* NTAS  uses ???????? */
119	work->ElectionCriterion  = (MAINTAIN_LIST)|(BROWSER_ELECTION_VERSION<<8);
120	work->ElectionCriterion |= (lp_os_level() << 24);
121	if (lp_domain_master())
122		work->ElectionCriterion |= 0x80;
123
124	return work;
125}
126
127/*******************************************************************
128  Remove a workgroup.
129******************************************************************/
130
131static struct work_record *remove_workgroup_from_subnet(struct subnet_record *subrec,
132                                     struct work_record *work)
133{
134	struct work_record *ret_work = NULL;
135
136	DEBUG(3,("remove_workgroup: Removing workgroup %s\n", work->work_group));
137
138	ret_work = work->next;
139
140	remove_all_servers(work);
141
142	if (!work->serverlist) {
143		if (work->prev)
144			work->prev->next = work->next;
145		if (work->next)
146			work->next->prev = work->prev;
147
148		if (subrec->workgrouplist == work)
149			subrec->workgrouplist = work->next;
150
151		ZERO_STRUCTP(work);
152		SAFE_FREE(work);
153	}
154
155	subrec->work_changed = True;
156
157	return ret_work;
158}
159
160/****************************************************************************
161  Find a workgroup in the workgroup list of a subnet.
162**************************************************************************/
163
164struct work_record *find_workgroup_on_subnet(struct subnet_record *subrec,
165                                             const char *name)
166{
167	struct work_record *ret;
168 	unstring un_name;
169
170	DEBUG(4, ("find_workgroup_on_subnet: workgroup search for %s on subnet %s: ",
171		name, subrec->subnet_name));
172
173	name_to_unstring(un_name, name);
174
175	for (ret = subrec->workgrouplist; ret; ret = ret->next) {
176		if (strequal(ret->work_group,un_name)) {
177			DEBUGADD(4, ("found.\n"));
178			return(ret);
179		}
180	}
181	DEBUGADD(4, ("not found.\n"));
182	return NULL;
183}
184
185/****************************************************************************
186  Create a workgroup in the workgroup list of the subnet.
187**************************************************************************/
188
189struct work_record *create_workgroup_on_subnet(struct subnet_record *subrec,
190                                               const char *name, int ttl)
191{
192	struct work_record *work = NULL;
193
194	DEBUG(4,("create_workgroup_on_subnet: creating group %s on subnet %s\n",
195		name, subrec->subnet_name));
196
197	if ((work = create_workgroup(name, ttl))) {
198		add_workgroup(subrec, work);
199		subrec->work_changed = True;
200		return(work);
201	}
202
203	return NULL;
204}
205
206/****************************************************************************
207  Update a workgroup ttl.
208**************************************************************************/
209
210void update_workgroup_ttl(struct work_record *work, int ttl)
211{
212	if(work->death_time != PERMANENT_TTL)
213		work->death_time = time(NULL)+(ttl*3);
214	work->subnet->work_changed = True;
215}
216
217/****************************************************************************
218 Fail function called if we cannot register the WORKGROUP<0> and
219 WORKGROUP<1e> names on the net.
220**************************************************************************/
221
222static void fail_register(struct subnet_record *subrec, struct response_record *rrec,
223                          struct nmb_name *nmbname)
224{
225	DEBUG(0,("fail_register: Failed to register name %s on subnet %s.\n",
226		nmb_namestr(nmbname), subrec->subnet_name));
227}
228
229/****************************************************************************
230 If the workgroup is our primary workgroup, add the required names to it.
231**************************************************************************/
232
233void initiate_myworkgroup_startup(struct subnet_record *subrec, struct work_record *work)
234{
235	int i;
236
237	if(!strequal(lp_workgroup(), work->work_group))
238		return;
239
240	/* If this is a broadcast subnet then start elections on it if we are so configured. */
241
242	if ((subrec != unicast_subnet) && (subrec != remote_broadcast_subnet) &&
243			(subrec != wins_server_subnet) && lp_preferred_master() && lp_local_master()) {
244		DEBUG(3, ("initiate_myworkgroup_startup: preferred master startup for \
245workgroup %s on subnet %s\n", work->work_group, subrec->subnet_name));
246		work->needelection = True;
247		work->ElectionCriterion |= (1<<3);
248	}
249
250	/* Register the WORKGROUP<0> and WORKGROUP<1e> names on the network. */
251
252	register_name(subrec,lp_workgroup(),0x0,samba_nb_type|NB_GROUP, NULL, fail_register,NULL);
253	register_name(subrec,lp_workgroup(),0x1e,samba_nb_type|NB_GROUP, NULL, fail_register,NULL);
254
255	for( i = 0; my_netbios_names(i); i++) {
256		const char *name = my_netbios_names(i);
257		int stype = lp_default_server_announce() | (lp_local_master() ?  SV_TYPE_POTENTIAL_BROWSER : 0 );
258
259		if(!strequal(global_myname(), name))
260			stype &= ~(SV_TYPE_MASTER_BROWSER|SV_TYPE_POTENTIAL_BROWSER|SV_TYPE_DOMAIN_MASTER|SV_TYPE_DOMAIN_MEMBER);
261
262		create_server_on_workgroup(work,name,stype|SV_TYPE_LOCAL_LIST_ONLY, PERMANENT_TTL,
263				string_truncate(lp_serverstring(), MAX_SERVER_STRING_LENGTH));
264		DEBUG(3,("initiate_myworkgroup_startup: Added server name entry %s \
265on subnet %s\n", name, subrec->subnet_name));
266	}
267}
268
269/****************************************************************************
270  Dump a copy of the workgroup database into the log file.
271  **************************************************************************/
272
273void dump_workgroups(BOOL force_write)
274{
275	struct subnet_record *subrec;
276	int debuglevel = force_write ? 0 : 4;
277
278	for (subrec = FIRST_SUBNET; subrec; subrec = NEXT_SUBNET_INCLUDING_UNICAST(subrec)) {
279		if (subrec->workgrouplist) {
280			struct work_record *work;
281
282			if( DEBUGLVL( debuglevel ) ) {
283				dbgtext( "dump_workgroups()\n " );
284				dbgtext( "dump workgroup on subnet %15s: ", subrec->subnet_name );
285				dbgtext( "netmask=%15s:\n", inet_ntoa(subrec->mask_ip) );
286			}
287
288			for (work = subrec->workgrouplist; work; work = work->next) {
289				DEBUGADD( debuglevel, ( "\t%s(%d) current master browser = %s\n", work->work_group,
290					work->token, *work->local_master_browser_name ? work->local_master_browser_name : "UNKNOWN" ) );
291				if (work->serverlist) {
292					struct server_record *servrec;
293					for (servrec = work->serverlist; servrec; servrec = servrec->next) {
294						DEBUGADD( debuglevel, ( "\t\t%s %8x (%s)\n",
295							servrec->serv.name,
296							servrec->serv.type,
297							servrec->serv.comment ) );
298					}
299				}
300			}
301		}
302	}
303}
304
305/****************************************************************************
306  Expire any dead servers on all workgroups. If the workgroup has expired
307  remove it.
308  **************************************************************************/
309
310void expire_workgroups_and_servers(time_t t)
311{
312	struct subnet_record *subrec;
313
314	for (subrec = FIRST_SUBNET; subrec; subrec = NEXT_SUBNET_INCLUDING_UNICAST(subrec)) {
315		struct work_record *work;
316		struct work_record *nextwork;
317
318		for (work = subrec->workgrouplist; work; work = nextwork) {
319			nextwork = work->next;
320			expire_servers(work, t);
321
322			if ((work->serverlist == NULL) && (work->death_time != PERMANENT_TTL) &&
323					((t == (time_t)-1) || (work->death_time < t))) {
324				DEBUG(3,("expire_workgroups_and_servers: Removing timed out workgroup %s\n",
325						work->work_group));
326				remove_workgroup_from_subnet(subrec, work);
327			}
328		}
329	}
330}
331