source3/nmbd/nmbd_workgroupdb.c

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