source3/nmbd/nmbd_workgroupdb.c

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