SeRMN Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Reserves automàtiques per l'estona de manteniment (des de 2022-08) ======

Els scripts i les tasques periòdiques programades (''cron'', ''crontab'') que creaven les reserves setmanals varen estar en funcionament des de finals de 2013 fins principis de març de 2022. Llavors vàrem canviar la freqüència de les recàrregues dels imants i els scripts es varen haver d'adaptar.

La informació sobre els antics scripts i tasques periòdiques programades es troba a la pàgina [[sermn_wiki:userpages:marta:reserves_automatiques_manteniment | Reserves automàtiques per l'estona de manteniment (de 2013-10 a 2022-03)]].

**IMPORTANT:** Les reserves per les estones de manteniment es crearan automàticament amb vuit setmanes d'antelació, per tal que, si s'escau, hi hagi prou temps per modificar-les.

===== Instal·lar el paquet "dateutils" =====

Instal·lo el paquet ''dateutils'' per facilitar el càlcul amb dates:

<file>
$ sudo apt install dateutils                   
[sudo] password for sermnadmin: ******                                     
Reading package lists... Done                                   
Building dependency tree                                              
Reading state information... Done                                    
The following NEW packages will be installed:                          
  dateutils                                   
0 upgraded, 1 newly installed, 0 to remove and 15 not upgraded.
Need to get 217 kB of archives.            
After this operation, 1,555 kB of additional disk space will be used.
Get:1 http://ftp.es.debian.org/debian buster/main amd64 dateutils amd64 0.4.3-1 [217 kB]
Fetched 217 kB in 0s (586 kB/s)   
Selecting previously unselected package dateutils.                   
(Reading database ... 253630 files and directories currently installed.)
Preparing to unpack .../dateutils_0.4.3-1_amd64.deb ...           
Unpacking dateutils (0.4.3-1) ...                     
Setting up dateutils (0.4.3-1) ...                          
Processing triggers for install-info (6.5.0.dfsg.1-4+b1) ...    
Processing triggers for man-db (2.8.5-2) ...                   
</file>


===== maintenance_bookings_2022.sh =====

<WRAP todo>
FIXME cal adaptar el script.
</WRAP>

Aquest es el programet que crea les reserves per l'estona de manteniment. S'executa tots els diumenges a les 3 de la matinada, i crea les reserves amb dues setmanes d'antelació per tal que es puguin modificar si s'escau. El programet també envia un correu electrònic indicant si ha pogut fer les reserves.

<code bash maintenance_bookings_2022.sh>
#!/bin/bash
#
# maintenance_bookings_2022.sh
#
# (c) 2013, Miquel Cabanas, SeRMN, UAB
#
# Started writing:  2013/10/28
# Last updated:     2013/10/28
#
# This script runs the MySql commands needed to automatically create the
# bookings for the spectrometers maintenance tasks, mainly liquid nitrogen
# refills.
#
# To run this script every Sunday 2am append an entry like,
#
# FIXME 0 3 * * Sun /opt/bmbee-114-1/bin/maintenance_nmr_bookings.sh
#
# to crontab. This entry means, at minute 0, hour 2, on every (*) day of
# the month and on every (*) month of the year, if that day happens to be
# a Sunday (day 0), execute the commands in the script file
# 'maintenance_nmr_bookings.sh' (this file).


# VARIABLES ---------------------------------------------------------------

# programs
#
date=`which date`
mail=`which mail`
mysql=`which mysql`

# email recipients and subject

to_address="miquel.cabanas@uab.cat"
# cc_address="miriam.perez@uab.cat,pau.nolis@uab.cat,eva.monteagudo@uab.cat"
cc_address="miquel.cabanas@gmail.com,miquel.cabanas@uab.es"
subject="SeRMN Booking System - Weekly maintenance reservations"

# date related variables. This script runs on Sunday, and bookings are made
# eight weeks in advance (56 days) on Wednesday from 09:00 to 13:00. Hence,
# we need to find those dates so that we can use them later when booking time-slots.
#
# NOTE: these date variables are not currently used for booking commands,
# only for the reporting email messages.

today_date=`$date --date='Today' +'%Y/%m/%d'`	# 2013/10/28
mon_date_mail=`$date --date='8 week 3 day' +'%a %Y/%m/%d'`	# Thu 2013/12/06
mon_weekno=`$date --date='8 week 3 day' +'%V/%Y'`	# 52/2013

# Bumblebee booking system database where everything gets stored

myuser='*****'
mypass='*****'
mydb='*****'


# INSERT BOOKING ENTRIES IN THE DATABAE -----------------------------------------

$mysql --database=$mydb --user=$myuser --password=$mypass << EOF
/* begin transaction */
BEGIN;
/* Insert bookings for weekly maintenance tasks in all vertical magnets. */
/* By default, book Wednesday morning from 09:00 to 13:00, 8 weeks in advance */
/* (i.e. 59 days)   */

/* Avance DPX-250-QNP (250-AUTO) - Wednesday from 09:00 to 13:00 -> 4 hours */
INSERT INTO bookings(bookwhen, duration, instrument, bookedby, userid, projectid, discount, ip, comments, log, deleted) VALUES (date_add( date_add( current_date(), interval 59 day), interval 9 hour), '04:00:00', 12, 7, 7, 1, 0, '192.168.2.2', 'Weekly maintenance tasks', 'Weekly maintenance tasks', 0);

/* Avance DPX-250-BACS (250-ROBOT) - Wednesday from 09:00 to 13:00 -> 4 hours */
INSERT INTO bookings(bookwhen, duration, instrument, bookedby, userid, projectid, discount, ip, comments, log, deleted) VALUES (date_add( date_add( current_date(), interval 59 day), interval 9 hour), '04:00:00', 15, 7, 7, 1, 0, '192.168.2.2', 'Weekly maintenance tasks', 'Weekly maintenance tasks', 0);

/* Avance DPX-360 - Wednesday from 09:00 to 13:00 -> 4 hours */
INSERT INTO bookings(bookwhen, duration, instrument, bookedby, userid, projectid, discount, ip, comments, log, deleted) VALUES (date_add( date_add( current_date(), interval 59 day), interval 9 hour), '04:00:00', 1, 7, 7, 1, 0, '192.168.2.2', 'Weekly maintenance tasks', 'Weekly maintenance tasks', 0);

/* AvanceIII 400SB - Wednesday from 09:00 to 13:00 -> 4 hours */
INSERT INTO bookings(bookwhen, duration, instrument, bookedby, userid, projectid, discount, ip, comments, log, deleted) VALUES (date_add( date_add( current_date(), interval 59 day), interval 9 hour), '04:00:00', 6, 7, 7, 1, 0, '192.168.2.2', 'Weekly maintenance tasks', 'Weekly maintenance tasks', 0);

/* AvanceII 400WB - Wednesday from 09:00 to 13:00 -> 4 hours */
INSERT INTO bookings(bookwhen, duration, instrument, bookedby, userid, projectid, discount, ip, comments, log, deleted) VALUES (date_add( date_add( current_date(), interval 59 day), interval 9 hour), '04:00:00', 9, 7, 7, 1, 0, '192.168.2.2', 'Weekly maintenance tasks', 'Weekly maintenance tasks', 0);

/* Avance DRX-500 - Wednesday from 09:00 to 13:00 -> 4 hours */
INSERT INTO bookings(bookwhen, duration, instrument, bookedby, userid, projectid, discount, ip, comments, log, deleted) VALUES (date_add( date_add( current_date(), interval 59 day), interval 9 hour), '04:00:00', 2, 7, 7, 1, 0, '192.168.2.2', 'Weekly maintenance tasks', 'Weekly maintenance tasks', 0);

/* AvanceII+ 600 - Wednesday from 09:00 to 13:00 -> 4 hours */
INSERT INTO bookings(bookwhen, duration, instrument, bookedby, userid, projectid, discount, ip, comments, log, deleted) VALUES (date_add( date_add( current_date(), interval 59 day), interval 9 hour), '04:00:00', 7, 7, 7, 1, 0, '192.168.2.2', 'Weekly maintenance tasks', 'Weekly maintenance tasks', 0);

/* Hypersense DNP - Wednesday from 09:00 to 13:00 -> 4 hours */
INSERT INTO bookings(bookwhen, duration, instrument, bookedby, userid, projectid, discount, ip, comments, log, deleted) VALUES (date_add( date_add( current_date(), interval 59 day), interval 9 hour), '04:00:00', 17, 7, 7, 1, 0, '192.168.2.2', 'Weekly maintenance tasks', 'Weekly maintenance tasks', 0);

/* commit transaction */
COMMIT;
EOF


# MAIL THE SYSTEM AND INSTRUMENT ADMINISTRATORS - -----------------------
#
# Report to the system and instrument administrators whether Routine NMR
# bookings have been created.
#
status=$?

if [ $status -ne 0 ]; then
  # mysql command failed. Send an email reporting the failure
  #
  $mail -s "$subject" -c $cc_address $to_address << EOM

  AUTOMATED EMAIL MESSAGE. DO NOT REPLY

  SeRMN - Universitat Autonoma de Barcelona

  Failed to allocate time slots for weekly maintenance tasks
  week $mon_weekno starting: $mon_date_mail.

  Please, report this issue to the system administrator.

EOM

else
  # mysql command suceeded. Send an email reporting that routine
  # bookings have been created
  #
  $mail -s "$subject" -c $cc_address $to_address << EOM

  AUTOMATED EMAIL MESSAGE. DO NOT REPLY

  SeRMN - Universitat Autonoma de Barcelona

  Time slots have been allocated for weekly maintenance tasks
  on all SeRMN spectrometers for week $mon_weekno starting:
  $mon_date_mail.

EOM

fi

exit
</code>

El programet envia el següent correu electrònic si ha aconseguit fer les reserves,

<file>
-------- Original Message --------
Subject: SeRMN Booking System - Weekly maintenance reservations
Date: 	 Sun, 27 Oct 2013 16:54:46 +0300
From: 	 root <root@sermn.uab.cat>
To: 	 Miquel.Cabanas@uab.cat

AUTOMATED EMAIL MESSAGE. DO NOT REPLY

SeRMN - Universitat Autonoma de Barcelona

Time slots have been allocated for weekly maintenance tasks
on all SeRMN spectrometers for week 52/2013 starting:
Mon 2013/12/23.
</file>

i aquest altre missatge en cas contrari,

<file>
-------- Original Message --------
Subject: SeRMN Booking System - NMR Routine reservations
Date: 	 Sun, 27 Oct 2013 16:54:46 +0300
From:    root <root@sermn.uab.cat>
To:      Miquel.Cabanas@uab.cat

AUTOMATED EMAIL MESSAGE. DO NOT REPLY

SeRMN - Universitat Autonoma de Barcelona

Failed to allocate time slots for weekly maintenance tasks
week 52/2013 starting: Mon 2013/12/23.

Please, report this issue to the system administrator.
</file>


===== Entrada al registre crontab =====

<WRAP todo>
FIXME cal adaptar la programació del script.
</WRAP>

Aquesta és l'entrada creada al programa ''crontab'' per executar automàticament el programet que crear les reserves (crontab -u root -l):

<file>
# Bumblebee 1.1.4 - Automated bookings for weekly maintenance tasks. It runs
# on Sunday at 03:00.
#
0   3    *    *    Sun	/opt/bmbee-114-1/bin/maintenance_bookings.sh
</file>


===== Seguretat =====

<WRAP todo>
FIXME cal comprovar els permisos.
</WRAP>

Per motius de seguretat (el programet conté el nom d'usuari i clau de pas de la base de dades de reserves) la carpeta ''/opt/bmbee-114-1/bin/'' està protegida i té l'accés restringit,
  * permisos carpeta ''bin'': 700
  * permisos fitxer ''maintenance_bookings.sh'': 700
  * propietari (user:group): root:root

A més, per impedir el seu accés a través del servidor web, la carpeta ''bin'' conté un fitxer ''.htaccess'' amb el següent contingut:

<file>
order deny,allow
deny from all
</file>

===== Documentació =====

==== BASH date math ====

  * [[https://www.linuxjournal.com/content/doing-date-math-command-line-part-i | Doing Date Math on the Command Line, Part I | Linux Journal.]]
    * [[https://www.linuxjournal.com/content/doing-date-math-command-line-part-ii | Doing Date Math on the Command Line, Part II | Linux Journal.]]
  * [[https://linuxconfig.org/addition-and-subtraction-arithmetics-with-linux-date-command | Addition and subtraction arithmetics with Linux date command - Linux Tutorials - Learn Linux Configuration.]]
  * [[https://www.shell-tips.com/bash/math-arithmetic-calculation/#gsc.tab=0 | Math Arithmetic: How To Do Calculation in Bash?]]
  * [[https://www.google.com/search?client=firefox-b-e&q=bash+date+arithmetic | bash date arithmetic - Cerca de Google.]]

==== BASH modulus operator ====

  * [[https://linuxhint.com/modulus-bash/ | How to Use Modulus in Bash?]]
  * [[https://tldp.org/LDP/abs/html/ops.html | 8.1. Operators,]] in Chapter 8. Operations and Related Topics. //Advanced Bash-Scripting Guide. An in-depth exploration of the art of shell scripting.// Mendel Cooper, 2014.


==== Debugging BASH ====

  * [[https://www.baeldung.com/linux/debug-bash-script | Debugging a Bash Script.]]
  * [[https://www.shell-tips.com/bash/debug-script/ | 5 Simple Steps On How To Debug a Bash Shell Script.]]
  * [[https://tldp.org/LDP/abs/html/debugging.html | Chapter 32. Debugging.]] //Advanced Bash-Scripting Guide. An in-depth exploration of the art of shell scripting.// Mendel Cooper, 2014.
  * [[https://www.shellcheck.net/ | ShellCheck – shell script analysis tool.]]
    * [[https://github.com/koalaman/shellcheck | GitHub - koalaman/shellcheck: ShellCheck, a static analysis tool for shell scripts.]]
  * [[https://google.github.io/styleguide/shellguide.html | Google Shell Style Guide.]] Revision 2.02. Authored, revised and maintained by many Googlers.
    * [[https://unix.stackexchange.com/questions/449498/call-function-declared-below | call function declared below.]] :info: check recommnendations about ''main "$@"; exit'' and ''<nowiki>[[ ${BASH_SOURCE[0]} = "$0" ]]</nowiki> && Main "$@"''.


==== Dateutils ====

  * [[http://www.fresse.org/dateutils/ | Dateutils]] are a bunch of tools that revolve around fiddling with dates and times in the command line with a strong focus on use cases that arise when dealing with large amounts of financial data.
    * [[https://github.com/hroptatyr/dateutils | GitHub - hroptatyr/dateutils:]] nifty command line date and time utilities; fast date calculations and conversion in the shell.
  * [[https://packages.debian.org/search?searchon=names&keywords=dateutils | Debian -- Package Search Results -- dateutils.]]


==== Cron ====

  * [[https://en.wikipedia.org/wiki/Cron#CRON_expression | cron - Wikipedia.]]
  * [[https://crontab.guru/#20,50_7-13_*_*_* | Crontab.guru - The cron schedule expression editor.]]
  * [[https://unix.stackexchange.com/questions/210739/getting-crontab-events-that-would-happen-given-a-start-date-time
  * cron | Getting crontab events that would happen given a start date/time - Unix & Linux Stack Exchange.]]
SeRMN Wiki

User Tools

Site Tools

Page Tools
