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
## @{

OLSR_NAMESERVICE_SERVICE_TRIGGER=/usr/sbin/on_nameservice_trigger
SERVICES_FILE=/var/run/services_olsr
OLSR_HTTP_PORT=8080


# 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.
update_olsr_interfaces() {
    trap "error_trap update_olsr_interfaces '$*'" $GUARD_TRAPS
    local value=
    local interfaces
    interfaces=$(get_zone_interfaces "$ZONE_MESH")
    # physische Interfaces werden beispielsweise durch die mesh-Interfaces erzeugt
    local devices
    devices=$(get_zone_raw_devices "$ZONE_MESH")
    # fuehrende Leerzeichen entfernen; Zeilenumbrueche in Leerzeichen verwandeln
    value=$(echo "$interfaces $devices" | sed 's/^ *//; s/ *$//' | tr '\n' ' ' | sed 's/^ *//; s/ *$//')
    uci set -q "olsrd.@Interface[0].interface=$value"
    apply_changes olsrd
}


# 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 '$*'" $GUARD_TRAPS
    local lib_file
    local uci_prefix=
    local library="olsrd_$1"
    local current
    current=$(find_all_uci_sections olsrd LoadPlugin | while read uci_prefix; do
            # die Bibliothek beginnt mit dem Namen - danach folgt die genaue Versionsnummer
            uci_get "${uci_prefix}.library" | grep -q "^$library\.so" && echo "$uci_prefix"
        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 "" $GUARD_TRAPS && 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 '$*'" $GUARD_TRAPS
    # 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 '$*'" $GUARD_TRAPS
    local libpath=/usr/lib
    local libline
    local libfile
    local uci_prefix
    local ignore
    find_all_uci_sections "olsrd" "LoadPlugin" | while read uci_prefix; 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 '$*'" $GUARD_TRAPS
    local olsr_name
    local iproute_name
    local olsr_id
    local iproute_id
    while read 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" -a "$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" || true
    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() {
    trap "error_trap parse_olsr_service_descriptions '$*'" $GUARD_TRAPS
    local url
    local proto
    local service
    local details
    local scheme
    local host
    local port
    local path
    # verwende "|" und Leerzeichen als Separatoren
    local IFS='| '
    while read url proto service details; do
        scheme=$(echo "$url" | cut -f 1 -d :)
        host=$(echo "$url" | cut -f 3 -d / | cut -f 1 -d :)
        port=$(echo "$url" | cut -f 3 -d / | cut -f 2 -d :)
        path=/$(echo "$url" | cut -f 4- -d /)
        # Firmware-Versionen bis v0.4-5 veroeffentlichten folgendes Format:
        #    http://192.168.0.40:8080|tcp|ugw upload:50 download:15300 ping:23
        [ "$scheme" = "http" -a "$port" = "8080" -a "$proto" = "tcp" ] && \
            [ "$service" = "gw" -o "$service" = "ugw" ] && scheme=openvpn && port=1600 && proto=udp && service=gw
        echo -e "$scheme\t$host\t$port\t$path\t$proto\t$service\t$details"
    done
}


# 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):
#   SCHEME IP PORT PATH PROTO SERVICE DETAILS
# Im Fall von "http://192.168.0.15:8080|tcp|ugw upload:3 download:490 ping:108" entspricht dies:
#   http   192.168.0.15   8080   tcp   ugw   upload:3 download:490 ping:108
get_olsr_services() {
    trap "error_trap get_olsr_services '$*'" $GUARD_TRAPS
    local wanted_type="${1:-}"
    local filter_service
    local url
    local proto
    local service
    local details
    local scheme
    local host
    local port
    local path
    [ ! -e "$SERVICES_FILE" ] && msg_debug "no olsr-services file found: $SERVICES_FILE" && return 0
    # remove trailing commentary (containing the service's source IP address)
    grep "^[^#]" "$SERVICES_FILE" | \
        sed 's/[\t ]\+#[^#]\+//' | \
        parse_olsr_service_descriptions | \
        # filtere die Ergebnisse nach einem Service-Typ, falls selbiger als erster Parameter angegeben wurde
        awk '{ if (("'$wanted_type'" == "") || ("'$wanted_type'" == $6)) 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 '$*'" $GUARD_TRAPS
    local scheme
    local ip
    local port
    local path
    local proto
    local service
    local details
    local olsr_services
    # aktuell verbreitete Dienste benachrichtigen
    olsr_services=$(get_olsr_services)
    # leere Liste? Keine Verbindung mit der Wolke? Keine Aktualisierung, keine Beraeumung ...
    [ -z "$olsr_services" ] && return
    echo "$olsr_services" | while read scheme ip port path proto service details; do
        notify_service "$service" "$scheme" "$ip" "$port" "$proto" "$path" "olsr" "$details" >/dev/null
    done
    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" | while read service_name; do
            timestamp=$(get_service_value "$service_name" "timestamp" 0)
            # der Service ist zu lange nicht aktualisiert worden
            [ "$timestamp" -lt "$min_timestamp" ] && delete_service "$service_name"
            true
        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. "links" oder "neighbours")
## @details Bei Problemen mit dem Verbindungsaufbau erscheint ein Hinweis im syslog.
request_olsrd_txtinfo() {
    local request="$1"
    echo "/$request" | timeout 2 nc localhost 2006 2>/dev/null || {
        # 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"
    }
}

# Ende der Doku-Gruppe
## @}