Code

Update french translation (fix all fuzzy's)
[nagiosplug.git] / plugins / check_ntp.c
index 86e3d0985bf4f2ee57fbf020844dfa150d8a060a..fdbdc141281868e9c3510f36a40806f060a55b99 100644 (file)
@@ -1,44 +1,37 @@
-/******************************************************************************
-*
+/*****************************************************************************
+* 
 * Nagios check_ntp plugin
-*
+* 
 * License: GPL
-* Copyright (c) 2006 sean finney <seanius@seanius.net>
-* Copyright (c) 2007 nagios-plugins team
-*
-* Last Modified: $Date$
-*
+* Copyright (c) 2006 Sean Finney <seanius@seanius.net>
+* Copyright (c) 2006-2008 Nagios Plugins Development Team
+* 
 * Description:
-*
+* 
 * This file contains the check_ntp plugin
-*
-*  This plugin to check ntp servers independant of any commandline
-*  programs or external libraries.
-*
-*
-* License Information:
-*
-* This program is free software; you can redistribute it and/or modify
+* 
+* This plugin to check ntp servers independant of any commandline
+* programs or external libraries.
+* 
+* 
+* This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
-* the Free Software Foundation; either version 2 of the License, or
+* the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
-*
+* 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
-*
+* 
 * You should have received a copy of the GNU General Public License
-* along with this program; if not, write to the Free Software
-* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
-
- $Id$
+* along with this program.  If not, see <http://www.gnu.org/licenses/>.
+* 
+* 
 *****************************************************************************/
 
 const char *progname = "check_ntp";
-const char *revision = "$Revision$";
-const char *copyright = "2007";
+const char *copyright = "2006-2008";
 const char *email = "nagiosplug-devel@lists.sourceforge.net";
 
 #include "common.h"
@@ -83,7 +76,7 @@ typedef struct {
 
 /* this structure holds data about results from querying offset from a peer */
 typedef struct {
-       time_t waiting;         /* ts set when we started waiting for a response */ 
+       time_t waiting;         /* ts set when we started waiting for a response */
        int num_responses;      /* number of successfully recieved responses */
        uint8_t stratum;        /* copied verbatim from the ntp_message */
        double rtdelay;         /* converted from the ntp_message */
@@ -153,7 +146,7 @@ typedef struct {
  they are divided into halves, each being a 16-bit int in network byte order:
  - the first 16 bits are an int on the left side of a decimal point.
  - the second 16 bits represent a fraction n/(2^16)
- likewise for the 64-bit "fixed point" numbers with everything doubled :) 
+ likewise for the 64-bit "fixed point" numbers with everything doubled :)
  **/
 
 /* macros to access the left/right 16 bits of a 32-bit ntp "fixed point"
@@ -201,7 +194,7 @@ typedef struct {
 /* NTP control message header is 12 bytes, plus any data in the data
  * field, plus null padding to the nearest 32-bit boundary per rfc.
  */
-#define SIZEOF_NTPCM(m) (12+ntohs(m.count)+((m.count)?4-(ntohs(m.count)%4):0))
+#define SIZEOF_NTPCM(m) (12+ntohs(m.count)+((ntohs(m.count)%4)?4-(ntohs(m.count)%4):0))
 
 /* finally, a little helper or two for debugging: */
 #define DBG(x) do{if(verbose>1){ x; }}while(0);
@@ -268,7 +261,7 @@ void print_ntp_control_message(const ntp_control_message *p){
        if(p->op&REM_RESP && p->op&OP_READSTAT){
                peer=(ntp_assoc_status_pair*)p->data;
                for(i=0;i<numpeers;i++){
-                       printf("\tpeer id %.2x status %.2x", 
+                       printf("\tpeer id %.2x status %.2x",
                               ntohs(peer[i].assoc), ntohs(peer[i].status));
                        if (PEER_SEL(peer[i].status) >= PEER_INCLUDED){
                                if(PEER_SEL(peer[i].status) >= PEER_SYNCSOURCE){
@@ -302,50 +295,52 @@ void setup_request(ntp_message *p){
  * this is done by filtering servers based on stratum, dispersion, and
  * finally round-trip delay. */
 int best_offset_server(const ntp_server_results *slist, int nservers){
-       int i=0, j=0, cserver=0, candidates[5], csize=0;
+       int i=0, cserver=0, best_server=-1;
 
        /* for each server */
        for(cserver=0; cserver<nservers; cserver++){
-               /* sort out servers with error flags */
-               if ( LI(slist[cserver].flags) != LI_NOWARNING ){
-                       if (verbose) printf("discarding peer id %d: flags=%d\n", cserver, LI(slist[cserver].flags));
-                       break;
+               /* We don't want any servers that fails these tests */
+               /* Sort out servers that didn't respond or responede with a 0 stratum;
+                * stratum 0 is for reference clocks so no NTP server should ever report
+                * a stratum 0 */
+               if ( slist[cserver].stratum == 0){
+                       if (verbose) printf("discarding peer %d: stratum=%d\n", cserver, slist[cserver].stratum);
+                       continue;
+               }
+               /* Sort out servers with error flags */
+               if ( LI(slist[cserver].flags) == LI_ALARM ){
+                       if (verbose) printf("discarding peer %d: flags=%d\n", cserver, LI(slist[cserver].flags));
+                       continue;
                }
 
-               /* compare it to each of the servers already in the candidate list */
-               for(i=0; i<csize; i++){
-                       /* does it have an equal or better stratum? */
-                       if(slist[cserver].stratum <= slist[i].stratum){
-                               /* does it have an equal or better dispersion? */
-                               if(slist[cserver].rtdisp <= slist[i].rtdisp){
-                                       /* does it have a better rtdelay? */
-                                       if(slist[cserver].rtdelay < slist[i].rtdelay){
-                                               break;
-                                       }
-                               }
-                       }
+               /* If we don't have a server yet, use the first one */
+               if (best_server == -1) {
+                       best_server = cserver;
+                       DBG(printf("using peer %d as our first candidate\n", best_server));
+                       continue;
                }
 
-               /* if we haven't reached the current list's end, move everyone
-                * over one to the right, and insert the new candidate */
-               if(i<csize){
-                       for(j=5; j>i; j--){
-                               candidates[j]=candidates[j-1];
+               /* compare the server to the best one we've seen so far */
+               /* does it have an equal or better stratum? */
+               DBG(printf("comparing peer %d with peer %d\n", cserver, best_server));
+               if(slist[cserver].stratum <= slist[best_server].stratum){
+                       DBG(printf("stratum for peer %d <= peer %d\n", cserver, best_server));
+                       /* does it have an equal or better dispersion? */
+                       if(slist[cserver].rtdisp <= slist[best_server].rtdisp){
+                               DBG(printf("dispersion for peer %d <= peer %d\n", cserver, best_server));
+                               /* does it have a better rtdelay? */
+                               if(slist[cserver].rtdelay < slist[best_server].rtdelay){
+                                       DBG(printf("rtdelay for peer %d < peer %d\n", cserver, best_server));
+                                       best_server = cserver;
+                                       DBG(printf("peer %d is now our best candidate\n", best_server));
+                               }
                        }
                }
-               /* regardless, if they should be on the list... */
-               if(i<5) {
-                       candidates[i]=cserver;
-                       if(csize<5) csize++;
-               /* otherwise discard the server */
-               } else {
-                       DBG(printf("discarding peer id %d\n", cserver));
-               }
        }
 
-       if(csize>0) {
-               DBG(printf("best server selected: peer %d\n", candidates[0]));
-               return candidates[0];
+       if(best_server >= 0) {
+               DBG(printf("best server selected: peer %d\n", best_server));
+               return best_server;
        } else {
                DBG(printf("no peers meeting synchronization criteria :(\n"));
                return -1;
@@ -354,7 +349,7 @@ int best_offset_server(const ntp_server_results *slist, int nservers){
 
 /* do everything we need to get the total average offset
  * - we use a certain amount of parallelization with poll() to ensure
- *   we don't waste time sitting around waiting for single packets. 
+ *   we don't waste time sitting around waiting for single packets.
  * - we also "manually" handle resolving host names and connecting, because
  *   we have to do it in a way that our lazy macros don't handle currently :( */
 double offset_request(const char *host, int *status){
@@ -392,6 +387,7 @@ double offset_request(const char *host, int *status){
        servers=(ntp_server_results*)malloc(sizeof(ntp_server_results)*num_hosts);
        if(servers==NULL) die(STATE_UNKNOWN, "can not allocate server array");
        memset(servers, 0, sizeof(ntp_server_results)*num_hosts);
+       DBG(printf("Found %d peers to check\n", num_hosts));
 
        /* setup each socket for writing, and the corresponding struct pollfd */
        ai_tmp=ai;
@@ -667,7 +663,7 @@ int process_arguments(int argc, char **argv){
                {0, 0, 0, 0}
        };
 
-       
+
        if (argc < 2)
                usage ("\n");
 
@@ -682,7 +678,7 @@ int process_arguments(int argc, char **argv){
                        exit(STATE_OK);
                        break;
                case 'V':
-                       print_revision(progname, revision);
+                       print_revision(progname, NP_VERSION);
                        exit(STATE_OK);
                        break;
                case 'v':
@@ -763,6 +759,9 @@ int main(int argc, char *argv[]){
 
        result = offset_result = jitter_result = STATE_OK;
 
+       /* Parse extra opts if any */
+       argv=np_extra_opts (&argc, argv, progname);
+
        if (process_arguments (argc, argv) == ERROR)
                usage4 (_("Could not parse arguments"));
 
@@ -833,49 +832,58 @@ int main(int argc, char *argv[]){
 
 
 void print_help(void){
-       print_revision(progname, revision);
+       print_revision(progname, NP_VERSION);
 
        printf ("Copyright (c) 2006 Sean Finney\n");
        printf (COPYRIGHT, copyright, email);
-  
-  printf ("%s\n", _("This plugin checks the selected ntp server"));
 
-  printf ("\n\n");
-  
+       printf ("%s\n", _("This plugin checks the selected ntp server"));
+
+       printf ("\n\n");
+
        print_usage();
        printf (_(UT_HELP_VRSN));
+       printf (_(UT_EXTRA_OPTS));
        printf (_(UT_HOST_PORT), 'p', "123");
        printf (" %s\n", "-w, --warning=THRESHOLD");
        printf ("    %s\n", _("Offset to result in warning status (seconds)"));
        printf (" %s\n", "-c, --critical=THRESHOLD");
        printf ("    %s\n", _("Offset to result in critical status (seconds)"));
-       printf (" %s\n", "-j, --warning=THRESHOLD");
+       printf (" %s\n", "-j, --jwarn=THRESHOLD");
        printf ("    %s\n", _("Warning threshold for jitter"));
-       printf (" %s\n", "-k, --critical=THRESHOLD");
+       printf (" %s\n", "-k, --jcrit=THRESHOLD");
        printf ("    %s\n", _("Critical threshold for jitter"));
        printf (_(UT_TIMEOUT), DEFAULT_SOCKET_TIMEOUT);
        printf (_(UT_VERBOSE));
 
        printf("\n");
        printf("%s\n", _("Notes:"));
-       printf(" %s\n", _("See:"));
-       printf(" %s\n", ("http://nagiosplug.sourceforge.net/developer-guidelines.html#THRESHOLDFORMAT"));
-       printf(" %s\n", _("for THRESHOLD format and examples."));
+       printf(_(UT_THRESHOLDS_NOTES));
+#ifdef NP_EXTRA_OPTS
+       printf("\n");
+       printf(_(UT_EXTRA_OPTS_NOTES));
+#endif
 
        printf("\n");
        printf("%s\n", _("Examples:"));
        printf(" %s\n", _("Normal offset check:"));
        printf("  %s\n", ("./check_ntp -H ntpserv -w 0.5 -c 1"));
+       printf("\n");
        printf(" %s\n", _("Check jitter too, avoiding critical notifications if jitter isn't available"));
        printf(" %s\n", _("(See Notes above for more details on thresholds formats):"));
        printf("  %s\n", ("./check_ntp -H ntpserv -w 0.5 -c 1 -j -1:100 -k -1:200"));
 
        printf (_(UT_SUPPORT));
+
+       printf ("%s\n", _("WARNING: check_ntp is deprecated. Please use check_ntp_peer or"));
+       printf ("%s\n\n", _("check_ntp_time instead."));
 }
 
 void
 print_usage(void)
 {
-  printf (_("Usage:"));
-  printf(" %s -H <host> [-w <warn>] [-c <crit>] [-j <warn>] [-k <crit>] [-v verbose]\n", progname);
+       printf ("%s\n", _("WARNING: check_ntp is deprecated. Please use check_ntp_peer or"));
+       printf ("%s\n\n", _("check_ntp_time instead."));
+       printf (_("Usage:"));
+       printf(" %s -H <host> [-w <warn>] [-c <crit>] [-j <warn>] [-k <crit>] [-v verbose]\n", progname);
 }