Code

Add newline after "Usage:" in --help
[nagiosplug.git] / plugins / check_apt.c
index 3fdee5d3095b2c07ee828c715e9d73e8e5236b3a..7efa596b278bcab9bbe893b76499da4fe9c27dad 100644 (file)
@@ -1,68 +1,90 @@
-/******************************************************************************
- * check_apt.c: check for available updates in apt package management systems
- * original author: sean finney <seanius@seanius.net> 
- *                  (with some common bits stolen from check_nagios.c)
- ******************************************************************************
-
- 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
- (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$
-******************************************************************************/
+/*****************************************************************************
+* 
+* Nagios check_apt plugin
+* 
+* License: GPL
+* Copyright (c) 2006-2008 Nagios Plugins Development Team
+* 
+* Original author: Sean Finney
+* 
+* Description:
+* 
+* This file contains the check_apt plugin
+* 
+* Check for available updates in apt package management systems
+* 
+* 
+* 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 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, see <http://www.gnu.org/licenses/>.
+* 
+*****************************************************************************/
 
 const char *progname = "check_apt";
-const char *revision = "$Revision$";
-const char *copyright = "2006";
+const char *copyright = "2006-2008";
 const char *email = "nagiosplug-devel@lists.sourceforge.net";
 
 #include "common.h"
 #include "runcmd.h"
 #include "utils.h"
-#include <regex.h>
-
-/* for now define the various apt calls as constants.  this may need
- * to change later. */
-#define APTGET_UPGRADE "/usr/bin/apt-get -o 'Debug::NoLocking=true' -s -qq upgrade"
-#define APTGET_DISTUPGRADE "/usr/bin/apt-get -o 'Debug::NoLocking=true' -s -qq dist-upgrade"
-#define APTGET_UPDATE "/usr/bin/apt-get -q update"
+#include "regex.h"
+
+/* some constants */
+typedef enum { UPGRADE, DIST_UPGRADE, NO_UPGRADE } upgrade_type;
+
+/* the default opts can be overridden via the cmdline */
+#define UPGRADE_DEFAULT_OPTS "-o 'Debug::NoLocking=true' -s -qq"
+#define UPDATE_DEFAULT_OPTS "-q"
+/* until i commit the configure.in patch which gets this, i'll define
+ * it here as well */
+#ifndef PATH_TO_APTGET
+# define PATH_TO_APTGET "/usr/bin/apt-get"
+#endif /* PATH_TO_APTGET */
+/* the RE that catches security updates */
+#define SECURITY_RE "^[^\\(]*\\([^ ]* (Debian-Security:|Ubuntu:[^/]*/[^-]*-security)"
 
 /* some standard functions */
 int process_arguments(int, char **);
 void print_help(void);
 void print_usage(void);
 
+/* construct the appropriate apt-get cmdline */
+char* construct_cmdline(upgrade_type u, const char *opts);
 /* run an apt-get update */
 int run_update(void);
 /* run an apt-get upgrade */
-int run_upgrade(int *pkgcount);
+int run_upgrade(int *pkgcount, int *secpkgcount);
 /* add another clause to a regexp */
 char* add_to_regexp(char *expr, const char *next);
 
 /* configuration variables */
 static int verbose = 0;      /* -v */
 static int do_update = 0;    /* whether to call apt-get update */
-static int dist_upgrade = 0; /* whether to call apt-get dist-upgrade */
-static char* do_include = NULL;  /* regexp to only include certain packages */
-static char* do_exclude = NULL;  /* regexp to only exclude certain packages */
+static upgrade_type upgrade = UPGRADE; /* which type of upgrade to do */
+static char *upgrade_opts = NULL; /* options to override defaults for upgrade */
+static char *update_opts = NULL; /* options to override defaults for update */
+static char *do_include = NULL;  /* regexp to only include certain packages */
+static char *do_exclude = NULL;  /* regexp to only exclude certain packages */
+static char *do_critical = NULL;  /* regexp specifying critical packages */
 
 /* other global variables */
 static int stderr_warning = 0;   /* if a cmd issued output on stderr */
 static int exec_warning = 0;     /* if a cmd exited non-zero */
 
 int main (int argc, char **argv) {
-       int result=STATE_UNKNOWN, packages_available=0;
+       int result=STATE_UNKNOWN, packages_available=0, sec_count=0;
+
+       /* Parse extra opts if any */
+       argv=np_extra_opts(&argc, argv, progname);
 
        if (process_arguments(argc, argv) == ERROR)
                usage_va(_("Could not parse arguments"));
@@ -79,18 +101,21 @@ int main (int argc, char **argv) {
        if(do_update) result = run_update();
 
        /* apt-get upgrade */
-       result = max_state(result, run_upgrade(&packages_available));
+       result = max_state(result, run_upgrade(&packages_available, &sec_count));
 
-       if(packages_available > 0){
+       if(sec_count > 0){
+               result = max_state(result, STATE_CRITICAL);
+       } else if(packages_available > 0){
                result = max_state(result, STATE_WARNING);
        } else {
                result = max_state(result, STATE_OK);
        }
 
-       printf("APT %s: %d packages available for %s.%s%s%s%s\n", 
+       printf(_("APT %s: %d packages available for %s (%d critical updates). %s%s%s%s\n"),
               state_text(result),
               packages_available,
-              (dist_upgrade)?"dist-upgrade":"upgrade",
+              (upgrade==DIST_UPGRADE)?"dist-upgrade":"upgrade",
+                  sec_count,
               (stderr_warning)?" warnings detected":"",
               (stderr_warning && exec_warning)?",":"",
               (exec_warning)?" errors detected":"",
@@ -109,15 +134,18 @@ int process_arguments (int argc, char **argv) {
                {"help", no_argument, 0, 'h'},
                {"verbose", no_argument, 0, 'v'},
                {"timeout", required_argument, 0, 't'},
-               {"update", no_argument, 0, 'u'},
-               {"dist-upgrade", no_argument, 0, 'd'},
-               {"include", no_argument, 0, 'i'},
-               {"exclude", no_argument, 0, 'e'},
+               {"update", optional_argument, 0, 'u'},
+               {"upgrade", optional_argument, 0, 'U'},
+               {"no-upgrade", no_argument, 0, 'n'},
+               {"dist-upgrade", optional_argument, 0, 'd'},
+               {"include", required_argument, 0, 'i'},
+               {"exclude", required_argument, 0, 'e'},
+               {"critical", required_argument, 0, 'c'},
                {0, 0, 0, 0}
        };
 
        while(1) {
-               c = getopt_long(argc, argv, "hVvt:udi:e:", longopts, NULL);
+               c = getopt_long(argc, argv, "hVvt:u::U::d::ni:e:c:", longopts, NULL);
 
                if(c == -1 || c == EOF || c == 1) break;
 
@@ -126,7 +154,7 @@ int process_arguments (int argc, char **argv) {
                        print_help();
                        exit(STATE_OK);
                case 'V':
-                       print_revision(progname, revision);
+                       print_revision(progname, NP_VERSION);
                        exit(STATE_OK);
                case 'v':
                        verbose++;
@@ -135,10 +163,28 @@ int process_arguments (int argc, char **argv) {
                        timeout_interval=atoi(optarg);
                        break;
                case 'd':
-                       dist_upgrade=1;
+                       upgrade=DIST_UPGRADE;
+                       if(optarg!=NULL){
+                               upgrade_opts=strdup(optarg);
+                               if(upgrade_opts==NULL) die(STATE_UNKNOWN, "strdup failed");
+                       }
+                       break;
+               case 'U':
+                       upgrade=UPGRADE;
+                       if(optarg!=NULL){
+                               upgrade_opts=strdup(optarg);
+                               if(upgrade_opts==NULL) die(STATE_UNKNOWN, "strdup failed");
+                       }
+                       break;
+               case 'n':
+                       upgrade=NO_UPGRADE;
                        break;
                case 'u':
                        do_update=1;
+                       if(optarg!=NULL){
+                               update_opts=strdup(optarg);
+                               if(update_opts==NULL) die(STATE_UNKNOWN, "strdup failed");
+                       }
                        break;
                case 'i':
                        do_include=add_to_regexp(do_include, optarg);
@@ -146,9 +192,12 @@ int process_arguments (int argc, char **argv) {
                case 'e':
                        do_exclude=add_to_regexp(do_exclude, optarg);
                        break;
+               case 'c':
+                       do_critical=add_to_regexp(do_critical, optarg);
+                       break;
                default:
                        /* print short usage statement if args not parsable */
-                       usage_va(_("Unknown argument - %s"), optarg);
+                       usage5();
                }
        }
 
@@ -156,90 +205,54 @@ int process_arguments (int argc, char **argv) {
 }
 
 
-/* informative help message */
-void print_help(void){
-       print_revision(progname, revision);
-       printf(_(COPYRIGHT), copyright, email);
-       printf(_("\
-This plugin checks for software updates on systems that use\n\
-package management systems based on the apt-get(8) command\n\
-found in Debian GNU/Linux\n\
-\n\n"));
-       print_usage();
-       printf(_(UT_HELP_VRSN));
-       printf(_(UT_TIMEOUT), timeout_interval);
-       printf(_("\n\
- -d, --dist-upgrade\n\
-   Perform a dist-upgrade instead of normal upgrade.\n\
- -i, --include=REGEXP\n\
-   Include only packages matching REGEXP.  Can be specified multiple times;\n\
-   the values will be combined together.  Default is to include all packages.\n\
- -e, --exclude=REGEXP\n\
-   Exclude packages matching REGEXP from the list of packages that would\n\
-   otherwise be excluded.  Can be specified multiple times; the values\n\
-   will be combined together.  Default is to exclude no packages.\n\n"));
-       printf(_("\
-The following options require root privileges and should be used with care: \
-\n\n"));
-       printf(_("\
- -u, --update\n\
-   First perform an 'apt-get update' (note: you may also need to use -t)\
-\n\n"));
-}
-
-/* simple usage heading */
-void print_usage(void){
-       printf ("Usage: %s [-du] [-t timeout]\n", progname);
-}
-
 /* run an apt-get upgrade */
-int run_upgrade(int *pkgcount){
-       int i=0, result=STATE_UNKNOWN, regres=0, pc=0;
+int run_upgrade(int *pkgcount, int *secpkgcount){
+       int i=0, result=STATE_UNKNOWN, regres=0, pc=0, spc=0;
        struct output chld_out, chld_err;
-       regex_t ireg, ereg;
-       char rerrbuf[64];
-       const char *default_include_expr="^Inst";
+       regex_t ireg, ereg, sreg;
+       char *cmdline=NULL, rerrbuf[64];
+       const char *include_ptr=NULL, *crit_ptr=NULL;
+
+       if(upgrade==NO_UPGRADE) return STATE_OK;
 
        /* compile the regexps */
-       if(do_include!=NULL){
-               regres=regcomp(&ireg, do_include, REG_EXTENDED);
-               if(regres!=0) {
-                       regerror(regres, &ireg, rerrbuf, 64);
-                       die(STATE_UNKNOWN, "%s: Error compiling regexp: %s",
-                           progname, rerrbuf);
-               }
-       } else {
-               regres=regcomp(&ireg, default_include_expr, REG_EXTENDED);
-               if(regres!=0) {
-                       regerror(regres, &ireg, rerrbuf, 64);
-                       die(STATE_UNKNOWN, "%s: Error compiling regexp: %s",
-                           progname, rerrbuf);
-               }
+       if(do_include!=NULL) include_ptr=do_include;
+       else include_ptr="^Inst";
+       if(do_critical!=NULL) crit_ptr=do_critical;
+       else crit_ptr=SECURITY_RE;
+
+       regres=regcomp(&ireg, include_ptr, REG_EXTENDED);
+       if(regres!=0) {
+               regerror(regres, &ireg, rerrbuf, 64);
+               die(STATE_UNKNOWN, _("%s: Error compiling regexp: %s"), progname, rerrbuf);
        }
+
        if(do_exclude!=NULL){
                regres=regcomp(&ereg, do_exclude, REG_EXTENDED);
                if(regres!=0) {
                        regerror(regres, &ereg, rerrbuf, 64);
-                       die(STATE_UNKNOWN, "%s: Error compiling regexp: %s",
+                       die(STATE_UNKNOWN, _("%s: Error compiling regexp: %s"),
                            progname, rerrbuf);
                }
        }
+       regres=regcomp(&sreg, crit_ptr, REG_EXTENDED);
+       if(regres!=0) {
+               regerror(regres, &ereg, rerrbuf, 64);
+               die(STATE_UNKNOWN, _("%s: Error compiling regexp: %s"),
+                   progname, rerrbuf);
+       }
 
-
+       cmdline=construct_cmdline(upgrade, upgrade_opts);
        /* run the upgrade */
-       if(dist_upgrade==0){
-               result = np_runcmd(APTGET_UPGRADE, &chld_out, &chld_err, 0);
-       } else {
-               result = np_runcmd(APTGET_DISTUPGRADE, &chld_out, &chld_err, 0);
-       }
+       result = np_runcmd(cmdline, &chld_out, &chld_err, 0);
        /* apt-get upgrade only changes exit status if there is an
         * internal error when run in dry-run mode.  therefore we will
         * treat such an error as UNKNOWN */
        if(result != 0){
                exec_warning=1;
                result = STATE_UNKNOWN;
-               fprintf(stderr, "'%s' exited with non-zero status.\n",
-                   APTGET_UPGRADE);
+               fprintf(stderr, _("'%s' exited with non-zero status.\n"),
+                   cmdline);
        }
 
        /* parse the output, which should only consist of lines like
@@ -262,6 +275,10 @@ int run_upgrade(int *pkgcount){
                        if(do_exclude==NULL ||
                           regexec(&ereg, chld_out.line[i], 0, NULL, 0)!=0){
                                pc++;
+                               if(regexec(&sreg, chld_out.line[i], 0, NULL, 0)==0){
+                                       spc++;
+                                       if(verbose) printf("*");
+                               }
                                if(verbose){
                                        printf("*%s\n", chld_out.line[i]);
                                }
@@ -269,6 +286,7 @@ int run_upgrade(int *pkgcount){
                }
        }
        *pkgcount=pc;
+       *secpkgcount=spc;
 
        /* If we get anything on stderr, at least set warning */
        if(chld_err.buflen){
@@ -280,6 +298,10 @@ int run_upgrade(int *pkgcount){
                        }
                }
        }
+       regfree(&ireg);
+       regfree(&sreg);
+       if(do_exclude!=NULL) regfree(&ereg);
+       free(cmdline);
        return result;
 }
 
@@ -287,17 +309,19 @@ int run_upgrade(int *pkgcount){
 int run_update(void){
        int i=0, result=STATE_UNKNOWN;
        struct output chld_out, chld_err;
+       char *cmdline;
 
        /* run the upgrade */
-       result = np_runcmd(APTGET_UPDATE, &chld_out, &chld_err, 0);
+       cmdline = construct_cmdline(NO_UPGRADE, update_opts);
+       result = np_runcmd(cmdline, &chld_out, &chld_err, 0);
        /* apt-get update changes exit status if it can't fetch packages.
         * since we were explicitly asked to do so, this is treated as
         * a critical error. */
        if(result != 0){
                exec_warning=1;
                result = STATE_CRITICAL;
-               fprintf(stderr, "'%s' exited with non-zero status.\n",
-                       APTGET_UPDATE);
+               fprintf(stderr, _("'%s' exited with non-zero status.\n"),
+                       cmdline);
        }
 
        if(verbose){
@@ -316,6 +340,7 @@ int run_update(void){
                        }
                }
        }
+       free(cmdline);
        return result;
 }
 
@@ -334,5 +359,108 @@ char* add_to_regexp(char *expr, const char *next){
                sprintf((char*)(re+strlen(re)-2), "|%s) ", next);
        }
 
-       return re;      
+       return re;
+}
+
+char* construct_cmdline(upgrade_type u, const char *opts){
+       int len=0;
+       const char *opts_ptr=NULL, *aptcmd=NULL;
+       char *cmd=NULL;
+
+       switch(u){
+       case UPGRADE:
+               if(opts==NULL) opts_ptr=UPGRADE_DEFAULT_OPTS;
+               else opts_ptr=opts;
+               aptcmd="upgrade";
+               break;
+       case DIST_UPGRADE:
+               if(opts==NULL) opts_ptr=UPGRADE_DEFAULT_OPTS;
+               else opts_ptr=opts;
+               aptcmd="dist-upgrade";
+               break;
+       case NO_UPGRADE:
+               if(opts==NULL) opts_ptr=UPDATE_DEFAULT_OPTS;
+               else opts_ptr=opts;
+               aptcmd="update";
+               break;
+       }
+
+       len+=strlen(PATH_TO_APTGET)+1; /* "/usr/bin/apt-get " */
+       len+=strlen(opts_ptr)+1;       /* "opts " */
+       len+=strlen(aptcmd)+1;         /* "upgrade\0" */
+
+       cmd=(char*)malloc(sizeof(char)*len);
+       if(cmd==NULL) die(STATE_UNKNOWN, "malloc failed");
+       sprintf(cmd, "%s %s %s", PATH_TO_APTGET, opts_ptr, aptcmd);
+       return cmd;
+}
+
+/* informative help message */
+void
+print_help (void)
+{
+  print_revision(progname, NP_VERSION);
+
+  printf(_(COPYRIGHT), copyright, email);
+
+  printf("%s\n", _("This plugin checks for software updates on systems that use"));
+  printf("%s\n", _("package management systems based on the apt-get(8) command"));
+  printf("%s\n", _("found in Debian GNU/Linux"));
+
+  printf ("\n\n");
+
+  print_usage();
+
+  printf(UT_HELP_VRSN);
+  printf(UT_EXTRA_OPTS);
+
+  printf(UT_TIMEOUT, timeout_interval);
+
+  printf (" %s\n", "-U, --upgrade=OPTS");
+  printf ("    %s\n", _("[Default] Perform an upgrade.  If an optional OPTS argument is provided,"));
+  printf ("    %s\n", _("apt-get will be run with these command line options instead of the"));
+  printf ("    %s", _("default "));
+  printf ("(%s).\n", UPGRADE_DEFAULT_OPTS);
+  printf ("    %s\n", _("Note that you may be required to have root privileges if you do not use"));
+  printf ("    %s\n", _("the default options."));
+  printf (" %s\n", "-d, --dist-upgrade=OPTS");
+  printf ("    %s\n", _("Perform a dist-upgrade instead of normal upgrade. Like with -U OPTS"));
+  printf ("    %s\n", _("can be provided to override the default options."));
+  printf (" %s\n", " -n, --no-upgrade");
+  printf ("    %s\n", _("Do not run the upgrade.  Probably not useful (without -u at least)."));
+  printf (" %s\n", "-i, --include=REGEXP");
+  printf ("    %s\n", _("Include only packages matching REGEXP.  Can be specified multiple times"));
+  printf ("    %s\n", _("the values will be combined together.  Any patches matching this list"));
+  printf ("    %s\n", _("cause the plugin to return WARNING status.  Others will be ignored."));
+  printf ("    %s\n", _("Default is to include all packages."));
+  printf (" %s\n", "-e, --exclude=REGEXP");
+  printf ("    %s\n", _("Exclude packages matching REGEXP from the list of packages that would"));
+  printf ("    %s\n", _("otherwise be included.  Can be specified multiple times; the values"));
+  printf ("    %s\n", _("will be combined together.  Default is to exclude no packages."));
+  printf (" %s\n", "-c, --critical=REGEXP");
+  printf ("    %s\n", _("If the full package information of any of the upgradable packages match"));
+  printf ("    %s\n", _("this REGEXP, the plugin will return CRITICAL status.  Can be specified"));
+  printf ("    %s\n", _("multiple times like above.  Default is a regexp matching security"));
+  printf ("    %s\n", _("upgrades for Debian and Ubuntu:"));
+  printf ("    \t\%s\n", SECURITY_RE);
+  printf ("    %s\n", _("Note that the package must first match the include list before its"));
+  printf ("    %s\n\n", _("information is compared against the critical list."));
+
+  printf ("%s\n\n", _("The following options require root privileges and should be used with care:"));
+  printf (" %s\n", "-u, --update=OPTS");
+  printf ("    %s\n", _("First perform an 'apt-get update'.  An optional OPTS parameter overrides"));
+  printf ("    %s\n", _("the default options.  Note: you may also need to adjust the global"));
+  printf ("    %s\n", _("timeout (with -t) to prevent the plugin from timing out if apt-get"));
+  printf ("    %s\n", _("upgrade is expected to take longer than the default timeout."));
+
+  printf(UT_SUPPORT);
+}
+
+
+/* simple usage heading */
+void
+print_usage(void)
+{
+  printf ("%s\n", _("Usage:"));
+  printf ("%s [[-d|-u|-U]opts] [-n] [-t timeout]\n", progname);
 }