olsr.sh

gehe zur Dokumentation dieser Datei

## @defgroup olsr OLSR
## @brief Konfiguration und Abfrage des OLSR-Diensts. Einlesen von Diensten announciert via olsrd-nameservice.
# Beginn der Doku-Gruppe
## @{
 
# shellcheck disable=SC2034
OLSR_NAMESERVICE_SERVICE_TRIGGER=/usr/sbin/on_nameservice_trigger
SERVICES_FILE=/var/run/services_olsr
# shellcheck disable=SC2034
OLSR_HTTP_PORT=8080
OLSR_UPDATE_LOCK_FILE=/var/run/on-update-olsr-interfaces.lock
 
 
# uebertrage die Netzwerke, die derzeit der Zone "opennet" zugeordnet sind, in die olsr-Konfiguration
# Anschliessend wird olsr und die firewall neugestartet.
# Dieses Skript sollte via hotplug bei Aenderungen der Netzwerkkonfiguration ausgefuehrt werden.
# Fuer jedes Interface wird eine separate UCI-Sektion angelegt.
update_olsr_interfaces() {
    trap 'error_trap update_olsr_interfaces "$*"' EXIT
    local uci_prefix
    local interfaces
    local current
    
    interfaces_log="$(get_zone_log_interfaces "$ZONE_MESH")"
    interfaces_phy="$(get_zone_raw_devices "$ZONE_MESH")"
    
    # Das uci Interface zu olsrd benötigt folgenden Input:
    # - log. Interfaces, welches mind ein phys. Interface enthalten
    # - phys. Interfaces, welche keinem log. Interface zugeordnet sind
    interfaces_olsr="$interfaces_phy"
    for interface_log in $interfaces_log; do
        subinterface="$(get_device_of_interface $interface_log)"
        # Fuege nur log. Interfaces hinzu, welche phys. Interfaces enthalten
        if [ -n "$subinterface" ]; then
            interfaces_olsr=$(echo -e "$interfaces_olsr\n$interface_log")
        fi
    done
 
    for uci_prefix in $(find_all_uci_sections "olsrd" "Interface"); do
        current=$(uci_get "${uci_prefix}.interface")
        if echo "$interfaces_olsr" | grep -qFw "$current"; then
            # OLSR fuer das Interface aktivieren
            uci set "${uci_prefix}.ignore=0"
        else
            # Interfaces entfernen, die nicht mehr in der on-Zone sind
            uci_delete "$uci_prefix"
        fi
    done
    # alle fehlenden Interfaces neu anlegen
    for current in $interfaces_olsr; do
        uci_prefix=$(find_first_uci_section "olsrd" "Interface" "interface=$current")
        # existiert es bereits? Dann wurde es oben konfiguriert.
        [ -n "$uci_prefix" ] && continue
        uci_prefix="olsrd.$(uci add olsrd Interface)"
        uci set "${uci_prefix}.interface=$current"
        uci set "${uci_prefix}.ignore=0"
    done
    # prevent recursive trigger chaining
    if acquire_lock "$OLSR_UPDATE_LOCK_FILE" 5 5; then
        initialize_olsrd_policy_routing
        update_opennet_zone_masquerading
        apply_changes olsrd
        rm -f "$OLSR_UPDATE_LOCK_FILE"
    fi
}
 
 
# Pruefe das angegebene olsrd-Plugin aktiv ist und aktiviere es, falls dies nicht der Fall sein sollte.
# Das Ergebnis ist die uci-Sektion (z.B. "olsrd.@LoadPlugin[1]") als String.
get_and_enable_olsrd_library_uci_prefix() {
    trap 'error_trap get_and_enable_olsrd_library_uci_prefix "$*"' EXIT
    local lib_file
    local uci_prefix=
    local library="olsrd_$1"
    local current
    current=$(for uci_prefix in $(find_all_uci_sections olsrd LoadPlugin); do
            # die Bibliothek beginnt mit dem Namen - danach folgt die genaue Versionsnummer
            uci_get "${uci_prefix}.library" | grep -q "^$library"'\.so' && echo "$uci_prefix"
            true
        done | tail -1)
    if [ -n "$current" ]; then
        uci_prefix=$(echo "$current" | cut -f 1 -d = | sed 's/\.library$//')
    else
        lib_file=$(find /usr/lib -type f -name "${library}.*")
        if [ -z "$lib_file" ]; then
            msg_error "Failed to find olsrd '$library' plugin. Some Opennet services will fail."
            trap "" EXIT && return 1
        fi
        uci_prefix="olsrd.$(uci add olsrd LoadPlugin)"
        uci set "${uci_prefix}.library=$(basename "$lib_file")"
    fi
    # Plugin aktivieren; Praefix ausgeben
    if [ -n "$uci_prefix" ]; then
        # moeglicherweise vorhandenen 'ignore'-Parameter abschalten
        uci_is_true "$(uci_get "${uci_prefix}.ignore" 0)" && uci set "${uci_prefix}.ignore=0"
        echo "$uci_prefix"
    fi
    return 0
}
 
 
# Setze die Einstellung MainIP in der olsr-Konfiguration:
# Quelle 1: der erste Parameter
# Quelle 2: on-core.settings.on_id
# Quelle 3: die vorkonfigurierte Standard-IP
# Anschliessend ist "apply_changes olsrd" erforderlich.
olsr_set_main_ip() {
    trap 'error_trap olsr_set_main_ip "$*"' EXIT
    # Auslesen der aktuellen, bzw. der Standard-IP
    local main_ip
    if [ $# -eq 1 ]; then
        main_ip="$1"
    else
        main_ip=$(get_main_ip)
    fi
 
    # die Main-IP ist die erste IP dieses Geraets
    uci set "olsrd.@olsrd[0].MainIp=$main_ip"
}
 
 
# Ermittle welche olsr-Module konfiguriert sind, ohne dass die Library vorhanden ist.
# Deaktiviere diese Module - fuer ein sauberes boot-Log.
disable_missing_olsr_modules() {
    trap 'error_trap disable_missing_olsr_modules "$*"' EXIT
    local libpath=/usr/lib
    local libfile
    local uci_prefix
    local ignore
    for uci_prefix in $(find_all_uci_sections "olsrd" "LoadPlugin"); do
        libfile=$(uci_get "${uci_prefix}.library")
        ignore=$(uci_get "${uci_prefix}.ignore")
        [ -n "$ignore" ] && uci_is_true "$ignore" && continue
        if [ ! -e "$libpath/$libfile" ]; then
            msg_info "Disabling missing olsr module '$libfile'"
            uci set "${uci_prefix}.ignore=1"
        fi
    done
    apply_changes olsrd
}
 
 
## @fn olsr_sync_routing_tables()
## @brief Synchronisiere die olsrd-Routingtabellen-Konfiguration mit den iproute-Routingtabellennummern.
## @details Im Konfliktfall wird die olsrd-Konfiguration an die iproute-Konfiguration angepasst.
olsr_sync_routing_tables() {
    trap 'error_trap olsr_sync_routing_tables "$*"' EXIT
    local olsr_name
    local iproute_name
    local olsr_id
    local iproute_id
    while read -r olsr_name iproute_name; do
        olsr_id=$(uci_get "olsrd.@olsrd[0].$olsr_name")
        iproute_id=$(get_routing_table_id "$iproute_name")
        # beide sind gesetzt und identisch? Alles ok ...
        [ -n "$olsr_id" ] && [ "$olsr_id" = "$iproute_id" ] && continue
        # eventuell Tabelle erzeugen, falls sie noch nicht existiert
        [ -z "$iproute_id" ] && iproute_id=$(add_routing_table "$iproute_name")
        # olsr passt sich im Zweifel der iproute-Nummer an
        [ "$olsr_id" = "$iproute_id" ] || uci set "olsrd.@olsrd[0].$olsr_name=$iproute_id"
    done << EOF
RtTable     $ROUTING_TABLE_MESH
RtTableDefault  $ROUTING_TABLE_MESH_DEFAULT
EOF
    apply_changes olsrd
}
 
 
# Einlesen eines olsrd-Nameservice-Service.
# Details zum Eingabe- und Ausgabeformat: siehe "get_olsr_services".
parse_olsr_service_descriptions() {
    awk -f /usr/lib/opennet/olsr_parse_service_descriptions.awk
}
 
 
# Parse die olsr-Service-Datei
# Die Service-Datei enthaelt Zeilen streng definierter Form (durchgesetzt vom nameservice-Plugin).
# Beispielhafte Eintraege:
#   http://192.168.0.15:8080|tcp|ugw upload:3 download:490 ping:108         #192.168.2.15
#   dns://192.168.10.4:53|udp|dns                                           #192.168.10.4
# Parameter: service-Type (z.B. "gw", "dns", "ntp", "mesh")
# Ergebnis (tab-separiert):
#   SERVICE SCHEME IP PORT PROTO PATH DETAILS
# Im Fall von "http://192.168.0.15:8080|tcp|ugw upload:3 download:490 ping:108" entspricht dies:
#   ugw http   192.168.0.15   8080   tcp   /    upload:3 download:490 ping:108
# shellcheck disable=SC2120
get_olsr_services() {
    trap 'error_trap get_olsr_services "$*"' EXIT
    local wanted_type="${1:-}"
    local filter_service
    [ ! -e "$SERVICES_FILE" ] && msg_debug "no olsr-services file found: $SERVICES_FILE" && return 0
    sort "$SERVICES_FILE" | uniq | \
        parse_olsr_service_descriptions | \
        # filtere die Ergebnisse nach einem Service-Typ, falls selbiger als erster Parameter angegeben wurde
        awk '{ if (("'"$wanted_type"'" == "") || ("'"$wanted_type"'" == $1)) print $0; }'
    return 0
}
 
 
## @fn update_olsr_services()
## @brief Verarbeite die aktuelle Dienst-Liste aus dem olsrd-nameservice-Plugin.
## @details Veraltete Dienste werden entfernt. Eventuelle Änderungen der DNS- und NTP-Serverliste
##   werden angewandt.
update_olsr_services() {
    trap 'error_trap update_olsr_services "$*"' EXIT
    local scheme
    local ip
    local port
    local path
    local proto
    local service
    local details
    local olsr_services
    # aktuell verbreitete Dienste benachrichtigen
    # shellcheck disable=SC2119
    olsr_services=$(get_olsr_services)
    # leere Liste? Keine Verbindung mit der Wolke? Keine Aktualisierung, keine Beraeumung ...
    [ -z "$olsr_services" ] && return
    echo "$olsr_services" | notify_services "olsr" >/dev/null
    # aktualisiere DNS- und NTP-Dienste
    apply_changes on-core
}
 
 
## @fn remove_old_olsr_services()
## @brief Entferne OLSR-Dienste, deren Einträge veraltet sind.
## @details Diese Funktion sollte etwa stündlich ausgeführt werden.
remove_old_olsr_services() {
    local service_name
    local timestamp
    local min_timestamp
    min_timestamp=$(($(get_uptime_minutes) - $(get_on_core_default "olsr_service_expire_minutes")))
    # veraltete Dienste entfernen (nur falls die uptime groesser ist als die Verfallszeit)
    if [ "$min_timestamp" -gt 0 ]; then
        get_services | filter_services_by_value "source" "olsr" | pipe_service_attribute "timestamp" "0" \
                | while read -r service_name timestamp; do
            # der Service ist zu lange nicht aktualisiert worden
            if [ -z "$timestamp" ] || [ "$timestamp" -lt "$min_timestamp" ]; then
                delete_service "$service_name"
            fi
        done
    fi
    # aktualisiere DNS- und NTP-Dienste
    apply_changes on-core
}
 
 
## @fn request_olsrd_txtinfo()
## @brief Sende eine Anfrage an das txtinfo-Interface von olsrd
## @param request Der zu sende Request-Pfad (z.B. "lin" oder "nei")
## @details Bei Problemen mit dem Verbindungsaufbau erscheint ein Hinweis im syslog.
request_olsrd_txtinfo() {
    local request="$1"
    if ! echo "/$request" | timeout 4 nc 127.0.0.1 2006 2>/dev/null; then
        # keine Fehlermeldung, falls wir uns gerade noch im Boot-Prozess befinden
        # Dies tritt besonders nach einem Reboot via Web-Interface auf, da dann die Status-Seite
        # noch während des Hochfahrens abgerufen wird.
        [ "$(get_uptime_seconds)" -lt 180 ] || msg_error "request_olsrd_txtinfo: olsrd is not responding"
    fi | if [ "$request" = "con" ] || [ "$request" = "all" ]; then
        # die Konfiguration und "all" sind ein unklares Format (fuer Menschen)
        cat
    else
        # alle nicht-Daten-Zeilen entfernen:
        #   * loesche alle Zeilen, bis die erste Zeile beginnend mit "Table: " erkannt wird
        #   * loesche die darauffolgende Zeile, sowie alle leeren Zeilen
        awk 'BEGIN { in_body=0;}
            { if (/^Table: /) { in_body=1; } else if (in_body == 1) { print; }}' \
            | sed '1d; /^$/d'
    fi
}
 
# Ende der Doku-Gruppe
## @}