lenses/ntp.aug

   1 (* NTP module for Augeas                      *)
   2 (* Author: Raphael Pinson <raphink@gmail.com> *)
   3 (*                                            *)
   4 (* Status: basic settings supported           *)
   5
   6 module Ntp =
   7   autoload xfm
   8
   9
  10     (* Define useful shortcuts *)
  11
  12     let eol = del /[ \t]*/ "" . [ label "#comment" . store /#.*/]?
  13             . Util.del_str "\n"
  14     let sep_spc = Util.del_ws_spc
  15     let word = /[^,# \n\t]+/
  16     let num  = /[0-9]+/
  17
  18
  19     (* define comments and empty lines *)
  20     let comment = [ label "#comment" . del /#[ \t]*/ "#" .
  21                     store /([^ \t\n][^\n]*)?/ . del "\n" "\n" ]
  22     let empty   = [ del /[ \t]*\n/ "\n" ]
  23
  24
  25     let kv (k:regexp) (v:regexp) =
  26       [ key k . sep_spc. store v . eol ]
  27
  28     (* Define generic record *)
  29     let record (kw:regexp) (value:lens) =
  30       [ key kw . sep_spc . store word . value . eol ]
  31
  32     (* Define a command record; see confopt.html#cfg in the ntp docs *)
  33     let command_record =
  34       let opt = [ sep_spc . key /minpoll|maxpoll|ttl|version|key/ .
  35                       sep_spc . store word ]
  36         | [ sep_spc . key (/autokey|burst|iburst|noselect|preempt/ |
  37                            /prefer|true|dynamic/) ] in
  38       let cmd = /server|peer|broadcast|manycastclient/
  39         | /multicastclient|manycastserver/ in
  40         record cmd opt*
  41
  42     let broadcastclient =
  43       [ key "broadcastclient" . [ sep_spc . key "novolley" ]? . eol ]
  44
  45     (* Define a fudge record *)
  46     let fudge_opt_re = "refid" | "stratum"
  47     let fudge_opt  = [ sep_spc . key fudge_opt_re . sep_spc . store word ]
  48     let fudge_record = record "fudge" fudge_opt?
  49
  50     (* Define simple settings, see miscopt.html in ntp docs *)
  51     let flags =
  52       let flags_re = /auth|bclient|calibrate|kernel|monitor|ntp|pps|stats/ in
  53       let flag = [ label "flag" . store flags_re ] in
  54         [ key /enable|disable/ . (sep_spc . flag)* . eol ]
  55
  56     let simple_setting (k:regexp) = kv k word
  57
  58     (* Still incomplete, misses logconfig, phone, setvar, tos,
  59        trap, ttl *)
  60     let simple_settings =
  61         kv "broadcastdelay" Rx.decimal
  62       | flags
  63       | simple_setting /driftfile|leapfile|logfile|includefile/
  64           | simple_setting "statsdir"
  65
  66     (* Misc commands, see miscopt.html in ntp docs *)
  67
  68     (* Define restrict *)
  69     let restrict_record   =
  70       let action    = [ label "action" . sep_spc . store word ] in
  71       [ key "restrict" . sep_spc .
  72           [ label "ipv6" . Util.del_str "-6" . sep_spc ]? .
  73           store (word - "-6") . action* . eol ]
  74
  75     (* Define statistics *)
  76     let statistics_flag (kw:string) = [ sep_spc . key kw ]
  77
  78     let statistics_opts = statistics_flag "loopstats"
  79                         | statistics_flag "peerstats"
  80                         | statistics_flag "clockstats"
  81                         | statistics_flag "rawstats"
  82
  83     let statistics_record = [ key "statistics" . statistics_opts* . eol ]
  84
  85
  86     (* Define filegen *)
  87     let filegen = del /filegen[ \t]+/ "filegen " . store word
  88     let filegen_opt (kw:string) = [ sep_spc . key kw . sep_spc . store word ]
  89     (* let filegen_flag (kw:string) = [ label kw . sep_spc . store word ] *)
  90     let filegen_select (kw:string) (select:regexp) = [ label kw . sep_spc . store select ]
  91
  92     let filegen_opts = filegen_opt "file"
  93                      | filegen_opt "type"
  94                      | filegen_select "enable" /(en|dis)able/
  95                      | filegen_select "link" /(no)?link/
  96
  97     let filegen_record = [ label "filegen" . filegen . filegen_opts* . eol ]
  98
  99     (* Authentication commands, see authopt.html#cmd; incomplete *)
 100     let auth_command =
 101       [ key /controlkey|keys|keysdir|requestkey|authenticate/ .
 102             sep_spc . store word . eol ]
 103      | [ key /autokey|revoke/ . [sep_spc . store word]? . eol ]
 104      | [ key /trustedkey/ . [ sep_spc . label "key" . store word ]+ . eol ]
 105
 106     (* tinker [step step | panic panic | dispersion dispersion |
 107                stepout stepout | minpoll minpoll | allan allan | huffpuff huffpuff] *)
 108     let tinker =
 109       let arg_names = /step|panic|dispersion|stepout|minpoll|allan|huffpuff/ in
 110       let arg = [ key arg_names . sep_spc . store Rx.decimal ] in
 111       [ key "tinker" . (sep_spc . arg)* . eol ]
 112
 113     (* tos [beacon beacon | ceiling ceiling | cohort {0 | 1} |
 114             floor floor | maxclock maxclock | maxdist maxdist |
 115             minclock minclock | mindist mindist | minsane minsane |
 116             orphan stratum | orphanwait delay] *)
 117
 118     let tos =
 119       let arg_names = /beacon|ceiling|cohort|floor|maxclock|maxdist|
 120                       minclock|mindist|minsane|orphan|orphanwait/ in
 121       let arg = [ key arg_names . sep_spc . store Rx.decimal ] in
 122       [ key "tos" . (sep_spc . arg)* . eol ]
 123
 124     (* Define lens *)
 125
 126     let lns = ( comment | empty | command_record | fudge_record
 127               | restrict_record | simple_settings | statistics_record
 128               | filegen_record | broadcastclient
 129               | auth_command | tinker | tos)*
 130
 131     let filter = (incl "/etc/ntp.conf")
 132
 133     let xfm = transform lns filter