1 This adds Service Location Protocol support.
3 To use this patch, run these commands for a successful build:
5 patch -p1 <patches/slp.diff
7 ./configure --enable-slp
10 TODO: the configure changes should abort if the user requests --enable-slp
11 and we can't honor that request.
13 based-on: 3b8f8192227b14e708bf535072485e50f4362270
14 diff --git a/Makefile.in b/Makefile.in
17 @@ -13,6 +13,8 @@ CFLAGS=@CFLAGS@
26 @@ -38,7 +40,7 @@ OBJS1=flist.o rsync.o generator.o receiver.o cleanup.o sender.o exclude.o \
27 OBJS2=options.o io.o compat.o hlink.o token.o uidlist.o socket.o hashtable.o \
28 fileio.o batch.o clientname.o chmod.o acls.o xattrs.o
29 OBJS3=progress.o pipe.o
30 -DAEMON_OBJ = params.o loadparm.o clientserver.o access.o connection.o authenticate.o
31 +DAEMON_OBJ = params.o loadparm.o clientserver.o access.o connection.o authenticate.o $(SLPOBJ)
32 popt_OBJS=popt/findme.o popt/popt.o popt/poptconfig.o \
33 popt/popthelp.o popt/poptparse.o
34 OBJS=$(OBJS1) $(OBJS2) $(OBJS3) $(DAEMON_OBJ) $(LIBOBJ) $(ZLIBOBJ) @BUILD_POPT@
35 @@ -74,7 +76,7 @@ install-strip:
36 $(MAKE) INSTALL_STRIP='-s' install
38 rsync$(EXEEXT): $(OBJS)
39 - $(CC) $(CFLAGS) $(LDFLAGS) -o $@ $(OBJS) $(LIBS)
40 + $(CC) $(CFLAGS) $(LDFLAGS) -o $@ $(OBJS) $(LIBS) $(LIBSLP)
43 $(CHECK_OBJS): $(HEADERS)
44 diff --git a/clientserver.c b/clientserver.c
47 @@ -1156,6 +1156,13 @@ int daemon_main(void)
48 * address too. In fact, why not just do inet_ntop on the
52 + if (register_services()) {
54 + "Couldn't register with service discovery protocol, continuing anyway\n");
58 start_accept_loop(rsync_port, start_daemon);
61 diff --git a/configure.in b/configure.in
64 @@ -668,6 +668,29 @@ if test $rsync_cv_can_hardlink_special = yes; then
65 AC_DEFINE(CAN_HARDLINK_SPECIAL, 1, [Define to 1 if link() can hard-link special files.])
68 +AC_ARG_ENABLE(slp, [ --disable-slp turn off SLP support, defaults to on])
69 +AC_ARG_WITH(openslp-libs, [ --with-openslp-libs set directory for OpenSLP library],
70 + LDFLAGS="-L$withval $LDFLAGS"
71 + DSOFLAGS="-L$withval $DSOFLAGS",)
72 +AC_ARG_WITH(openslp-includes, [ --with-openslp-includes set directory for OpenSLP includes],
73 + CFLAGS="-I$withval $CFLAGS"
74 + CXXFLAGS="-I$withval $CXXFLAGS"
75 + CPPFLAGS="-I$withval $CPPFLAGS",)
80 +if test x$enable_slp != xno; then
81 + AC_CHECK_HEADER(slp.h,
82 + AC_CHECK_LIB(slp, SLPOpen,
83 + AC_DEFINE(HAVE_LIBSLP, 1, [Define to 1 for SLP support])
84 + SLPOBJ="srvreg.o srvloc.o"
91 AC_CACHE_CHECK([for working socketpair],rsync_cv_HAVE_SOCKETPAIR,[
93 #include <sys/types.h>
94 diff --git a/loadparm.c b/loadparm.c
97 @@ -98,6 +98,9 @@ typedef struct {
106 /* This structure describes a single section. Their order must match the
107 @@ -312,6 +315,9 @@ static struct parm_struct parm_table[] =
108 {"motd file", P_STRING, P_GLOBAL,&Vars.g.motd_file, NULL,0},
109 {"pid file", P_STRING, P_GLOBAL,&Vars.g.pid_file, NULL,0},
110 {"port", P_INTEGER,P_GLOBAL,&Vars.g.rsync_port, NULL,0},
112 + {"slp refresh", P_INTEGER,P_GLOBAL,&Vars.g.slp_refresh, NULL,0},
114 {"socket options", P_STRING, P_GLOBAL,&Vars.g.socket_options, NULL,0},
116 {"auth users", P_STRING, P_LOCAL, &Vars.l.auth_users, NULL,0},
117 @@ -443,6 +449,9 @@ FN_GLOBAL_STRING(lp_pid_file, &Vars.g.pid_file)
118 FN_GLOBAL_STRING(lp_socket_options, &Vars.g.socket_options)
120 FN_GLOBAL_INTEGER(lp_rsync_port, &Vars.g.rsync_port)
122 +FN_GLOBAL_INTEGER(lp_slp_refresh, &Vars.g.slp_refresh)
125 FN_LOCAL_STRING(lp_auth_users, auth_users)
126 FN_LOCAL_STRING(lp_charset, charset)
127 diff --git a/main.c b/main.c
130 @@ -1213,6 +1213,18 @@ static int start_client(int argc, char *argv[])
132 if (!read_batch) { /* for read_batch, NO source is specified */
133 char *path = check_for_hostspec(argv[0], &shell_machine, &rsync_port);
135 + if (shell_machine && !shell_machine[0]) {
137 + /* User entered just rsync:// URI */
138 + print_service_list();
140 +#else /* No SLP, die here */
141 + rprintf(FINFO, "No SLP support, cannot browse\n");
142 + exit_cleanup(RERR_SYNTAX);
146 if (path) { /* source is remote */
149 diff --git a/options.c b/options.c
152 @@ -567,6 +567,7 @@ static void print_rsync_version(enum logcode f)
153 char const *links = "no ";
154 char const *iconv = "no ";
155 char const *ipv6 = "no ";
156 + char const *slp = "no ";
157 STRUCT_STAT *dumstat;
159 #if SUBPROTOCOL_VERSION != 0
160 @@ -600,6 +601,9 @@ static void print_rsync_version(enum logcode f)
161 #ifdef CAN_SET_SYMLINK_TIMES
168 rprintf(f, "%s version %s protocol version %d%s\n",
169 RSYNC_NAME, RSYNC_VERSION, PROTOCOL_VERSION, subprotocol);
170 @@ -613,8 +617,8 @@ static void print_rsync_version(enum logcode f)
171 (int)(sizeof (int64) * 8));
172 rprintf(f, " %ssocketpairs, %shardlinks, %ssymlinks, %sIPv6, batchfiles, %sinplace,\n",
173 got_socketpair, hardlinks, links, ipv6, have_inplace);
174 - rprintf(f, " %sappend, %sACLs, %sxattrs, %siconv, %ssymtimes\n",
175 - have_inplace, acls, xattrs, iconv, symtimes);
176 + rprintf(f, " %sappend, %sACLs, %sxattrs, %siconv, %ssymtimes, %sSLP\n",
177 + have_inplace, acls, xattrs, iconv, symtimes, slp);
179 #ifdef MAINTAINER_MODE
180 rprintf(f, "Panic Action: \"%s\"\n", get_panic_action());
181 diff --git a/rsync.h b/rsync.h
185 #define SIGNIFICANT_ITEM_FLAGS (~(\
186 ITEM_BASIS_TYPE_FOLLOWS | ITEM_XNAME_FOLLOWS | ITEM_LOCAL_CHANGE))
188 +/* this is the minimum we'll use, irrespective of config setting */
189 +/* definately don't set to less than about 30 seconds */
190 +#define SLP_MIN_TIMEOUT 120
192 #define CFN_KEEP_DOT_DIRS (1<<0)
193 #define CFN_KEEP_TRAILING_SLASH (1<<1)
194 #define CFN_DROP_TRAILING_DOT_DIR (1<<2)
195 diff --git a/rsync.yo b/rsync.yo
198 @@ -148,7 +148,12 @@ particular rsync daemon by leaving off the module name:
200 quote(tt(rsync somehost.mydomain.com::))
202 -See the following section for more details.
203 +And, if Service Location Protocol is available, the following will list the
204 +available rsync servers:
206 +quote(tt(rsync rsync://))
208 +See the following section for even more usage details.
210 manpagesection(ADVANCED USAGE)
212 diff --git a/rsyncd.conf b/rsyncd.conf
220 diff --git a/rsyncd.conf.yo b/rsyncd.conf.yo
223 @@ -120,6 +120,15 @@ details on some of the options you may be able to set. By default no
224 special socket options are set. These settings can also be specified
225 via the bf(--sockopts) command-line option.
227 +dit(bf(slp refresh)) This parameter is used to determine how long service
228 +advertisements are valid (measured in seconds), and is only applicable if
229 +you have Service Location Protocol support compiled in. If this is
230 +not set or is set to zero, then service advertisements never time out. If
231 +this is set to less than 120 seconds, then 120 seconds is used. If it is
232 +set to more than 65535, then 65535 is used (which is a limitation of SLP).
233 +Using 3600 (one hour) is a good number if you tend to change your
238 manpagesection(MODULE PARAMETERS)
239 @@ -766,6 +775,7 @@ use chroot = yes
241 syslog facility = local5
242 pid file = /var/run/rsyncd.pid
246 path = /var/ftp/./pub
247 diff --git a/socket.c b/socket.c
250 @@ -530,6 +530,16 @@ void start_accept_loop(int port, int (*fn)(int, int))
255 + time_t next_slp_refresh;
256 + short slp_timeout = lp_slp_refresh();
258 + if (slp_timeout < SLP_MIN_TIMEOUT)
259 + slp_timeout = SLP_MIN_TIMEOUT;
260 + /* re-register before slp times out */
265 #ifdef HAVE_SIGACTION
266 sigact.sa_flags = SA_NOCLDSTOP;
267 @@ -558,14 +568,25 @@ void start_accept_loop(int port, int (*fn)(int, int))
272 + next_slp_refresh = time(NULL) + slp_timeout;
275 /* now accept incoming connections - forking a new process
276 * for each incoming connection */
282 struct sockaddr_storage addr;
283 socklen_t addrlen = sizeof addr;
285 + struct timeval slp_tv;
287 + slp_tv.tv_sec = 10;
288 + slp_tv.tv_usec = 0;
291 /* close log file before the potentially very long select so
292 * file can be trimmed by another process instead of growing
293 @@ -578,7 +599,18 @@ void start_accept_loop(int port, int (*fn)(int, int))
297 - if (select(maxfd + 1, &fds, NULL, NULL, NULL) < 1)
299 + sel_ret = select(maxfd + 1, &fds, NULL, NULL,
300 + slp_timeout ? &slp_tv : NULL);
301 + if (sel_ret == 0 && slp_timeout && time(NULL) > next_slp_refresh) {
302 + rprintf(FINFO, "Service registration expired, refreshing it\n");
303 + register_services();
304 + next_slp_refresh = time(NULL) + slp_timeout;
307 + sel_ret = select(maxfd + 1, &fds, NULL, NULL, NULL);
312 for (i = 0, fd = -1; sp[i] >= 0; i++) {
313 diff --git a/srvloc.c b/srvloc.c
318 +/* -*- c-file-style: "linux"; -*-
320 + Copyright (C) 2002 by Brad Hards <bradh@frogmouth.net>
322 + This program is free software; you can redistribute it and/or modify
323 + it under the terms of the GNU General Public License as published by
324 + the Free Software Foundation; either version 2 of the License, or
325 + (at your option) any later version.
327 + This program is distributed in the hope that it will be useful,
328 + but WITHOUT ANY WARRANTY; without even the implied warranty of
329 + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
330 + GNU General Public License for more details.
332 + You should have received a copy of the GNU General Public License
333 + along with this program; if not, write to the Free Software
334 + Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
337 +/* This file implements the service location functionality */
338 +/* Basically, it uses normal Service Location Protocol API */
340 +/* It is really a cheap hack - just to show how it might work
341 + in a real application.
350 +/* This one just prints out the attributes */
351 +static SLPBoolean getAttrCallback(UNUSED(SLPHandle hslp), const char *attrlist,
352 + SLPError errcode, UNUSED(void *cookie))
356 + if (errcode == SLP_OK) {
357 + if (!strcmp(attrlist, "(comment=)"))
358 + rprintf(FINFO, "\t(No description)\n");
360 + cleanstr = strrchr(attrlist, ')') ;
361 + *cleanstr = ' '; /* remove last ')' */
362 + rprintf(FINFO, "\t%s\n", strchr(attrlist, '=') + 1);
368 +static SLPBoolean getSLPSrvURLCallback(UNUSED(SLPHandle hslp),
369 + const char *srvurl, UNUSED(unsigned short lifetime),
370 + SLPError errcode, void *cookie)
373 + SLPHandle attrhslp;
375 + if (errcode == SLP_OK) {
376 + /* chop service: off the front */
377 + rprintf(FINFO, " %s ", (strchr(srvurl, ':') + 1));
378 + /* check for any attributes */
379 + if (SLPOpen("en", SLP_FALSE,&attrhslp) == SLP_OK) {
380 + result = SLPFindAttrs(attrhslp, srvurl,
381 + "", /* return all attributes */
382 + "", /* use configured scopes */
383 + getAttrCallback, NULL);
384 + if (result != SLP_OK) {
385 + rprintf(FERROR, "errorcode: %i\n",result);
387 + SLPClose(attrhslp);
389 + *(SLPError*)cookie = SLP_OK;
391 + *(SLPError*)cookie = errcode;
393 + /* Return SLP_TRUE because we want to be called again
394 + * if more services were found. */
399 +int print_service_list(void)
402 + SLPError callbackerr;
405 + err = SLPOpen("en",SLP_FALSE,&hslp);
406 + if (err != SLP_OK) {
407 + rprintf(FERROR, "Error opening slp handle %i\n", err);
411 + SLPFindSrvs(hslp, "rsync",
412 + 0, /* use configured scopes */
413 + 0, /* no attr filter */
414 + getSLPSrvURLCallback, &callbackerr);
416 + /* Now that we're done using slp, close the slp handle */
421 diff --git a/srvreg.c b/srvreg.c
426 +/* -*- c-file-style: "linux"; -*-
428 + Copyright (C) 2002 by Brad Hards <bradh@frogmouth.net>
430 + This program is free software; you can redistribute it and/or modify
431 + it under the terms of the GNU General Public License as published by
432 + the Free Software Foundation; either version 2 of the License, or
433 + (at your option) any later version.
435 + This program is distributed in the hope that it will be useful,
436 + but WITHOUT ANY WARRANTY; without even the implied warranty of
437 + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
438 + GNU General Public License for more details.
440 + You should have received a copy of the GNU General Public License
441 + along with this program; if not, write to the Free Software
442 + Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
445 +/* This file implements the service registration functionality */
447 +/* Basically, it uses normal Service Location Protocol API */
453 +extern int rsync_port;
455 +static void slp_callback(UNUSED(SLPHandle hslp), SLPError errcode, void *cookie)
457 + /* return the error code in the cookie */
458 + *(SLPError*)cookie = errcode;
460 + /* You could do something else here like print out
461 + * the errcode, etc. Remember, as a general rule,
462 + * do not try to do too much in a callback because
463 + * it is being executed by the same thread that is
464 + * reading slp packets from the wire. */
467 +int register_services(void)
469 + SLPError err, callbackerr;
475 + char localhost[256];
476 + extern char *config_file;
478 + struct addrinfo aih, *ai = 0;
480 + if (!lp_load(config_file, 0)) {
481 + exit_cleanup(RERR_SYNTAX);
484 + n = lp_numservices();
486 + if (0 == lp_slp_refresh())
487 + timeout = SLP_LIFETIME_MAXIMUM; /* don't expire, ever */
488 + else if (SLP_MIN_TIMEOUT > lp_slp_refresh())
489 + timeout = SLP_MIN_TIMEOUT; /* use a reasonable minimum */
490 + else if (SLP_LIFETIME_MAXIMUM <= lp_slp_refresh())
491 + timeout = (SLP_LIFETIME_MAXIMUM - 1); /* as long as possible */
493 + timeout = lp_slp_refresh();
495 + rprintf(FINFO, "rsyncd registering %d service%s with slpd for %d seconds:\n", n, ((n==1)? "":"s"), timeout);
496 + err = SLPOpen("en",SLP_FALSE,&hslp);
497 + if (err != SLP_OK) {
498 + rprintf(FINFO, "Error opening slp handle %i\n",err);
501 + if (gethostname(localhost, sizeof localhost)) {
502 + rprintf(FINFO, "Could not get hostname: %s\n", strerror(errno));
505 + memset(&aih, 0, sizeof aih);
506 + aih.ai_family = PF_UNSPEC;
507 + aih.ai_flags = AI_CANONNAME;
508 + if (0 != (err = getaddrinfo(localhost, 0, &aih, &ai)) || !ai) {
509 + rprintf(FINFO, "Could not resolve hostname: %s\n", gai_strerror(err));
512 + /* Register each service with SLP */
513 + for (i = 0; i < n; i++) {
517 + snprintf(srv, sizeof srv, "service:rsync://%s:%d/%s",
521 + rprintf(FINFO, " %s\n", srv);
522 + if (lp_comment(i)) {
523 + snprintf(attr, sizeof attr, "(comment=%s)",
527 + srv, /* service to register */
529 + 0, /* this is ignored */
530 + attr, /* attributes */
531 + SLP_TRUE, /* new registration - don't change this */
532 + slp_callback, /* callback */
535 + /* err may contain an error code that occurred as the slp library
536 + * _prepared_ to make the call. */
537 + if (err != SLP_OK || callbackerr != SLP_OK)
538 + rprintf(FINFO, "Error registering service with slp %i\n", err);
540 + /* callbackerr may contain an error code (that was assigned through
541 + * the callback cookie) that occurred as slp packets were sent on
543 + if (callbackerr != SLP_OK)
544 + rprintf(FINFO, "Error registering service with slp %i\n",callbackerr);
547 + /* Now that we're done using slp, close the slp handle */
551 + /* refresh is done in main select loop */