Merge pull request 'fixed typo in README' (#30) from fix-readme-typo into main

Reviewed-on: https://git.disroot.org/pranav/pybatmesh/pulls/30

CHANGELOG.md

@@ -1,19 +1,52 @@
 # Changelog
 
+## [v0.5.3][] - 2022-08-03
+
+- Renamed to pybatmesh, to be more clear what the program does
+- code cleanup
+
+To update via the repo, do the following:
+
+```sh
+git remote set-url origin git@git.disroot.org:pranav/pybatmesh.git
+# or
+git remote set-url origin https://git.disroot.org/pranav/pybatmesh.git
+# remove naxlnet and install pybatmesh
+git pull && git checkout 38d0aa8ab5dd60f2febffda335df6df1ea143ab3 && make clean && sudo make purge && git checkout main && make && sudo make install
+```
+
+## [v0.5.2][] - 2021-12-10
+
+- Optimised auto gateway mode selection (#25)
+
+## [v0.5.1][] - 2021-10-22
+
+- Fixed stopping at boot when GNOME starts location service (#21)
+- Changes in directory structure
+
+## [v0.5.0][] - 2021-10-10
+
+- Better error messages
+- Sets gateway mode automatically (to choose the best available
+  connection). **This might cause problems with nodes running previous
+  version of naxalnet** (#15)
+- Cleanup before exit
+- Closed #19
+
 ## [v0.4.0][] - 2021-09-20
 
 - naxalnet is now a daemon! naxalnet will reconfigure the WiFi network
-  every time a WiFi adapter is plugged in or removed
+  every time a WiFi adapter is plugged in or removed (#14)
 - **Logging**: logs to systemd journal when run from systemd, stderr
-  otherwise
+  otherwise (#13)
 - New dependency `python-systemd`
 - Fixed dependency order in systemd service
 - Added `--verbose` argument
 
 ## [v0.3.0][] - 2021-08-19
 
-- Support for arguments
+- Support for arguments (#11)
-- Configuration file support with fallback values
+- Configuration file support with fallback values (#11)
 - Made messages more readable
 - Improved documentation in docstrings
 - Changed default name of mesh network. **This will make naxalnet
@@ -22,17 +55,23 @@
 
 ## [v0.2.0][] - 2021-07-26
 
-- rfkill support
+- rfkill support (#9)
-- rewrite into python module
+- rewrite into python module (#5)
 
 ## [v0.1.0][] - 2021-06-19
 
-Initial python version. At first, this was a shell script. Than it was
+Rewrite to python. At first, this was a shell script. Then it was
 converted into a single python file that did just what the shell script
 used to do. The shell script was not given a version.
 
-[unreleased]: https://git.disroot.org/pranav/naxalnet/compare/v0.4.0...HEAD
+- Closed #1 and #3
-[v0.4.0]: https://git.disroot.org/pranav/naxalnet/compare/v0.3.0...v0.4.0
+
-[v0.3.0]: https://git.disroot.org/pranav/naxalnet/compare/v0.2.0...v0.3.0
+[unreleased]: https://git.disroot.org/pranav/pybatmesh/compare/v0.5.3...HEAD
-[v0.2.0]: https://git.disroot.org/pranav/naxalnet/compare/v0.1.0...v0.2.0
+[v0.5.3]: https://git.disroot.org/pranav/pybatmesh/compare/v0.5.2...v0.5.3
-[v0.1.0]: https://git.disroot.org/pranav/naxalnet/releases/tag/v0.1.0
+[v0.5.2]: https://git.disroot.org/pranav/pybatmesh/compare/v0.5.1...v0.5.2
+[v0.5.1]: https://git.disroot.org/pranav/pybatmesh/compare/v0.5.0...v0.5.1
+[v0.5.0]: https://git.disroot.org/pranav/pybatmesh/compare/v0.4.0...v0.5.0
+[v0.4.0]: https://git.disroot.org/pranav/pybatmesh/compare/v0.3.0...v0.4.0
+[v0.3.0]: https://git.disroot.org/pranav/pybatmesh/compare/v0.2.0...v0.3.0
+[v0.2.0]: https://git.disroot.org/pranav/pybatmesh/compare/v0.1.0...v0.2.0
+[v0.1.0]: https://git.disroot.org/pranav/pybatmesh/releases/tag/v0.1.0

HACKING.md

@@ -1,31 +1,33 @@
 # Hacking
 
-Everyone can [hack][] naxalnet. See below for how to hack.
+Everyone can [hack][] pybatmesh. See below for how to hack.
 
 ## Reporting issues and suggesting ideas
 
 To report a bug or suggest an idea, create a new issue at
-<https://git.disroot.org/pranav/naxalnet/issues> with a
+<https://git.disroot.org/pranav/pybatmesh/issues>
-relevant label.
+
+While reporting a bug, you can add the debug messages to provide more
+data. Run `journalctl -fu pybatmesh` on a terminal emulator (this could
+take some time on some machines). Now on another one, type `sudo systemctl start pybatmesh.service` or whatever caused the error. Now copy the error
+messages and paste it in the issue body along with the description.
 
 ## Improving documentation
 
-The README and HACKING.md needs to be more beginner friendly.
+The README and HACKING.md needs to be more beginner friendly. See #20.
-See section below.
 
 ## Contribute code
 
-To push to this repo, you need your username to be in the
+To push to this repo, you need your username to be in the contributors
-contributors list. Add your username to issue #8 to add you
+list. Add your username to issue #8 to add you as a contributor. Before
-as a contributor. Before each commit, update the CHANGELOG.md
+each commit, update the CHANGELOG.md and `__version__` in
-and `__version__` in `naxalnet/__init__.py`
+`pybatmesh/__init__.py`
 
 ## Packaging
 
-Currently this program is only packaged for Arch Linux.
+Currently this program is only packaged for Arch Linux. pybatmesh needs
-naxalnet needs packages in GNU+Linux+systemd
+packages in GNU+Linux+systemd distributions such as Debian, Fedora,
-distributions such as Debian, Fedora, openSUSE,
+openSUSE, and nixos. If you know/like to package it in your distro, post a
-and nixos. If you know/like to package it in your distro,
+message to issue #6.
-post to issue #6.
 
 [hack]: https://catb.org/jargon/html/H/hack.html

MANIFEST.in

@@ -1,5 +0,0 @@
-include LICENSE
-include README.md
-include naxalnet.service
-include naxalnet.conf.example
-recursive-include systemd-networkd *

Makefile

@@ -1,27 +1,37 @@
-# This makefile uses setup.py under the hood.
+# This makefile uses setup.py under the hood. In debian, and therefore
-# In ubuntu, python and pip are symlinks to python2 and pip2, not
+# ubuntu, and in fedora, python and pip are symlinks to python2 and pip2,
-# python3. So we have to specify python as python3 by default.
+# not python3. So we have to specify python as python3 by default.
+
 PYTHON := python3
 PIP := pip3
+
+# This can be changed when creating a package for your POSIX distribution
 DESTDIR:= /
 
 all: build
 
-build: naxalnet/__init__.py
+# Build only when pybatmesh/__init__.py changes. We assume here that anyone
+# creating a new commit will first update the __version__ in
+# pybatmesh/__init__.py
+build: pybatmesh/__init__.py
 	$(PYTHON) setup.py build
 
-install: build
+install:
 	$(PYTHON) setup.py install --root="$(DESTDIR)" --optimize=1 --skip-build
 
 uninstall:
-	$(PIP) uninstall -y naxalnet
+	$(PIP) uninstall -y pybatmesh
-	rm -rf /usr/share/naxalnet /usr/lib/systemd/system/naxalnet.service
+	rm -rf /usr/share/pybatmesh /usr/lib/systemd/system/pybatmesh.service
-	@echo "The directory /etc/naxalnet was not removed." && \
+	@echo "make uninstall will not remove anything in /etc/pybatmesh" && \
 	echo "Do 'sudo make purge' to remove it."
 
-# remove config files, like apt purge
+rpm:
+	$(PYTHON) setup.py bdist_rpm --requires python3-dasbus,python3-systemd,iwd,systemd-networkd
+
+# Remove config files, like apt purge. Purge should first do what
+# uninstall does, so we add uninstall as a dependency to this rule.
 purge: uninstall
-	rm -rf /etc/naxalnet
+	rm -rf /etc/pybatmesh
 
 clean:
-	rm -rf build naxalnet.egg-info **/__pycache__
+	rm -rf build *.egg-info **/__pycache__ dist

README.md

@@ -1,49 +1,30 @@
-# naxalnet
+# pybatmesh
 
-**naxalnet** is a program to create a wireless mesh network for
+**pybatmesh** is a program to create a wireless mesh network for
-communicating with each other. It can be useful during an
+communicating with each other. It can be useful during an [internet
-[internet shutdown](#internet-shutdown), or to join
+shutdown](#internet-shutdown), or to join [online classes](#online-class)
-[online classes](#online-class) with a group of laptops.
+with a group of laptops. It uses [B.A.T.M.A.N. Advanced][batman-adv], an
-It uses [B.A.T.M.A.N. Advanced][batman-adv], an implementation
+implementation of the B.A.T.M.A.N. routing protocol to communicate with
-of the B.A.T.M.A.N. routing protocol to communicate with peers.
+peers.
-The name naxal comes from Naxalbari, a village in Darjeeling,
-West Bengal.
 
-WARNING:
+**WARNING**: This program uses an **unencrypted** network. This means you do
-This program uses an **unencrypted** network. This means
+not get any more privacy or security than with an open WiFi network.
-you do not get any more privacy or security than with an open WiFi
-network.
 
-<!-- NOTE TO ACTIVISTS
+## Features
 
-Running this program in the world's largest (partly-free) democracy
+- Select best network when multiple nodes have internet access (gateway
-may result in you getting arrested under the Act Which Must Not Be Named,
+  mode)
-and not getting bail because of false evidence planted in your phone by
+- Detect insertion and removal of wifi adapters and reconfigure them
-Pegasus, or by a forensic lab in Gujarat.
+- Readable logs
-
+- Supports rfkill
-The author, much like the GoI, does not wish to take responsibility in your
-well-being if you get arrested under a draconian national security law.
-
--->
-<!-- UNCOMMENT WHEN NECESSARY
-
-**Disclaimer**:
-In case you are either 1) a complete idiot; or 2) a member of the saffron
-brigade; or 3) both, please be aware that this project is not affiliated
-with any human rights groups designated as "terrorist" groups in India.
-
-Using the name naxal does not imply any form of connection
-with anyone currently at risk of death in overcrowded prisons.
-
--->
 
 ## Requirements
 
-- [systemd-networkd v248 or more][batman-systemd]
+- [systemd-networkd v248 or greater][batman-systemd]
-- Linux kernel with batman-adv module
+- Linux kernel with [batman-adv v2021.0][batman-systemd] or greater
 - [iwd][] for controlling the WiFi adapter
-- python3
+- python (tested on 3.9 and 3.10)
-- python3-setuptools, for building and installing naxalnet
+- python setuptools, for building and installing pybatmesh
 - [python-systemd][], for logging to systemd journal
 - [dasbus][], for communicating with iwd
 - two or more machines with a WiFi adapter having ibss support, called
@@ -53,39 +34,34 @@ with anyone currently at risk of death in overcrowded prisons.
 
 ## Installing
 
-This program is available in the AUR for Arch users. Building
+This program is available in the AUR for Arch users. Users of other
-manually for other distributions may not always work.
+distributions will have to build manually.
 
 ### Arch Linux
 
-Install [naxalnet][aur] (or [naxalnet-git][aur-devel] for the
+Install [pybatmesh][aur] (or [pybatmesh-git][aur-devel] for the
 development version) from the AUR with your favourite helper:
 
 ```sh
-yay -S naxalnet
+yay -S pybatmesh
 ```
 
-Optionally, [setup systemd-resolved][arch-resolved] for DNS if any
+Optionally, [setup systemd-resolved][arch-resolved] for DNS. [Start
-of the nodes have internet access. [Start naxalnet][startnx] when
+pybatmesh][startnx] when you need it.
-you need it.
 
-### Ubuntu
+### Debian or Ubuntu
 
-naxalnet is not packaged for Ubuntu, so you will have to build
+pybatmesh is not packaged for Debian or Ubuntu, so you will have to build
-and install it manually.
+and install it manually. Currently, only Debian bookworm (testing) and
-Currently, only the **unreleased 21.10** comes with the
+Ubuntu 21.10 comes with the required version of systemd. Therefore,
-required version of systemd. Therefore, naxalnet **won't work on Ubuntu
+pybatmesh requires **Debian testing** or **Ubuntu 21.10 or greater** to
-21.04 or older**.
+work.
 
-<!-- TODO: remove this message if systemd 248 arrives in 21.04 -->
+Install the requirements from the repositories:
-
-Install the requirements from the Ubuntu repositories:
 
 ```sh
 # batctl is optional
-sudo apt install python3-pip python3-systemd iwd batctl build-essential
+sudo apt install python3-pip python3-systemd python3-dasbus iwd batctl
-# Now, install dasbus with pip
-sudo pip3 install dasbus
 ```
 
 Now follow the instructions in the
@@ -93,29 +69,56 @@ Now follow the instructions in the
 
 ### Fedora
 
-naxalnet is not packaged for Fedora, so it should be installed
+pybatmesh is not packaged for Fedora, so it should be installed manually.
-manually. naxalnet requires atleast systemd v248 which is only
+pybatmesh requires at least systemd v248, which is only available on
-available on **Fedora 34 and above**. Install the dependencies:
+**Fedora 34 and above**. python-setuptools support building rpms, which
+are the preferred way of installing software in Fedora. Follow the steps
+to install pybatmesh on Fedora:
 
 ```sh
-# systemd-resolved may be required for rawhide
+# Install the build requirements
-sudo dnf install systemd-networkd iwd python3-dasbus python3-setuptools python3-systemd
+sudo dnf install python3-setuptools make git
-```
 
-Now head over to the [next section][install-manual] to install naxalnet.
+# Clone the repo
+git clone https://git.disroot.org/pranav/pybatmesh.git
+cd pybatmesh
+
+# Create an installable rpm from the source code
+make rpm
+
+# Now install it. This will also install the requirements
+sudo dnf install dist/pybatmesh-$(python3 -m setup --version)-1.noarch.rpm
+```
 
 ### Manually
 
-Install the [requirements][requirements].
+Verify that the [requirements][] are of required versions.
-
-Clone the naxalnet repo and cd into it.
 
 ```sh
-git clone https://git.disroot.org/pranav/naxalnet.git
+# Should be greater than or equal to 2021.0
-cd naxalnet
+batctl -v
+
+# 248 or greater
+systemctl --version
+
+# Atleast 4.4
+uname -r
+
+# >= 3.6
+python3 --version
+
+# Check for IBSS (ad-hoc) support in your WiFi firmware or driver
+iw phy | grep -q join_ibss && echo "IBSS is supported" || echo "IBSS not supported"
 ```
 
-Now, build and install naxalnet:
+Clone the pybatmesh repo and cd into it.
+
+```sh
+git clone https://git.disroot.org/pranav/pybatmesh.git
+cd pybatmesh
+```
+
+Now, build and install pybatmesh:
 
 ```sh
 make
@@ -135,70 +138,86 @@ To upgrade, clean the build files, update the repo and reinstall:
 make clean
 git pull
 make
-sudo make uninstall install
+sudo make uninstall
+sudo make install
 ```
 
 This will keep the configuration files.
 
 ## How to use
 
-You need more than one machine running naxalnet for the connection to work.
+You need more than one machine running pybatmesh for the connection to work.
 
-### Start naxalnet
+### Start pybatmesh
 
-Though naxalnet can run from the command line, it was designed to be
+Though pybatmesh can run from the command line, it was designed to be
 run as a systemd service.
-To start naxalnet, do the command on all the nodes:
+To start pybatmesh, do the command on all the nodes:
 
 ```sh
-sudo systemctl start naxalnet.service
+sudo systemctl start pybatmesh.service
 ```
 
-This will start a mesh network and connect to all nodes.
+This will start a mesh network and connect to all nodes. To test if it
-To test if it works, run `sudo batctl n -w` and check for
+works, run `sudo batctl n -w` and check for nodes. If there are any nodes,
-nodes. If there are any nodes, your network is up. Press
+your network is up. Press Ctrl+C to stop `batctl`.
-Ctrl+C to stop `batctl`.
 
 ### Getting internet access
 
-Connect an ethernet cable from a router to any of the nodes and
+Connect an ethernet cable from a router to any of the nodes. Now restart
-renew the DHCP connection of all peers. To do this, type
+pybatmesh on the node to set `gateway_mode` to `server`. Other nodes will
+take a minute or more to renew DHCP. You can optionally do this manually
+if you don't want the delay. To do this, type
 `sudo networkctl renew bridge0` on all nodes.
 
 ### Tethering via WiFi AP
 
-If there are two adapters in a peer, naxalnet will start a
+If there are two adapters in a peer, pybatmesh will start a
 WiFi ap (also called WiFi hotspot) on one of them.
 
 Connect two WiFi adapters on a node.
 Now an AP will be started on one of the adapters.
-Type `naxalnet --print-wifi` to get the WiFi SSID and password.
+Type `pybatmesh --print-wifi` to get the WiFi SSID and password.
 
 If you had set up internet access on one of the nodes, internet
 can be accessed from the AP.
 
 ### Running at boot
 
-To run naxalnet at boot, enable the service on all the nodes:
+To run pybatmesh at boot, enable the service on all the nodes:
 
 ```sh
-sudo systemctl enable naxalnet.service
+sudo systemctl enable pybatmesh.service
 ```
 
-Now naxalnet will start a mesh on every boot.
+Now pybatmesh will start a mesh on every boot.
-Disable the service to stop running at boot:
+
+If you have NetworkManager enabled, which is the default in Ubuntu and
+Fedora, it should be disabled:
 
 ```sh
-sudo systemctl disable naxalnet.service
+sudo systemctl disable NetworkManager.service
+```
+
+To stop running at boot, you should disable `pybatmesh.service`:
+
+```sh
+sudo systemctl disable pybatmesh.service
+```
+
+If you had disabled `NetworkManager` before, enable it:
+
+```sh
+sudo systemctl enable NetworkManager.service
 ```
 
 ### Stopping the service
 
 ```sh
-sudo systemctl stop naxalnet iwd systemd-networkd systemd-resolved
+sudo systemctl stop pybatmesh iwd systemd-networkd systemd-resolved
 ```
 
-If your distribution uses NetworkManager, starting `naxalnet.service`
+If your distribution uses NetworkManager, starting `pybatmesh.service`
 will have stopped it. Start NetworkManager again:
 
 ```sh
@@ -207,23 +226,27 @@ sudo systemctl start NetworkManager.service
 
 ### Configuration
 
-naxalnet comes with a sample configuration file
+pybatmesh comes with a sample configuration file
-`/etc/naxalnet/naxalnet.conf.example`. To change how the program
+`/etc/pybatmesh/pybatmesh.conf.example`. To change how the program
-behaves, copy it to /etc/naxalnet/naxalnet.conf and edit it:
+behaves, copy it to /etc/pybatmesh/pybatmesh.conf and edit it:
 
 ```sh
-sudo cp /etc/naxalnet/naxalnet.conf{.example,}
+sudo cp /etc/pybatmesh/pybatmesh.conf{.example,}
 # Now edit the file with your favourite editor as root
-gedit admin:/etc/naxalnet/naxalnet.conf
+gedit admin:/etc/pybatmesh/pybatmesh.conf
 ```
 
 Also, you can change its behaviour every time you run it using
 arguments:
 
 ```sh
-naxalnet --help
+pybatmesh --help
 ```
 
+## Contributing or reporting bugs
+
+See [HACKING.md](HACKING.md)
+
 ## How it works
 
 There are three modes commonly supported by WiFi adapters - `ap` (WiFi
@@ -231,46 +254,40 @@ hotspot), `station` (for joining WiFi networks) and `ad-hoc` (or ibss, for
 decentralised networks). There are other modes supported by some WiFi
 adapters too, like `p2p` (WiFi direct), but this program doesn't use them.
 
-naxalnet uses two modes - `ad-hoc` and `ap`, for connecting to the
+pybatmesh uses two modes - `ad-hoc` and `ap`, for connecting to the
-mesh. naxalnet uses iwd to start an `ad-hoc` network and configures
+mesh. pybatmesh uses iwd to start an `ad-hoc` network and configures
 systemd-networkd to setup a BATMAN Advanced network.
 If there are two WiFi adapters connected to the machine,
-naxalnet starts an ad-hoc on one of them and an ap on the other.
+pybatmesh starts an ad-hoc on one of them and an ap on the other.
 You can use the ap for connecting mobile phones and other devices
 to the mesh network.
 
 Read the code and the documentation in the code to learn the details.
-See the directory [systemd-networkd](systemd-networkd) to see how
+See the directory [network](network) to see how
 systemd-networkd configures the network.
 
 ## Use cases
 
 ### Online class
 
-naxalnet can be used to share connections to join online classes.
+pybatmesh can be used to share connections to join online classes. You need
-You need at least one device with internet access.
+at least one device with internet access if you are not using a program
-
+like [Jami][] (see below).
-<!--
-
-### Malign democracies and well-established institutions
-
-Withheld due to national security reasons.
-
--->
 
 ### Internet shutdown
 
-You can communicate with neighbouring devices running naxalnet, using
+You can communicate with neighbouring devices running pybatmesh, using
-services like [IPFS][], [Jami][], [Secure Scuttlebutt][ssb] and others
+services like [IPFS][], [Jami][], [Briar][] [Secure Scuttlebutt][ssb] or
-which can work on an intranet. They should be installed on your
+similar software which can work on an intranet. They should be installed
-machine _before_ your friendly democratic government announces an
+on your machine _before_ your friendly democratic government announces an
-[internet shutdown][], since you cannot download and install them
+[internet shutdown][], since you cannot download and install them during a
-during a shutdown. When a shutdown occurs, [enable naxalnet][enablenx].
+shutdown. When a shutdown occurs, [enable pybatmesh][enable-pybatmesh] and use the
+installed software to communicate with anyone within range.
 
 ## Uninstalling
 
-If you installed naxalnet manually, use make uninstall to remove
+If you installed pybatmesh manually, use make uninstall to remove
-naxalnet and its data files. This requires python pip to be installed.
+pybatmesh and its data files. This requires python pip to be installed.
 
 ```sh
 # Uninstall the program, keeping the config files
@@ -279,32 +296,28 @@ sudo make uninstall
 sudo make purge
 ```
 
-## Contributing or reporting bugs
-
-See [HACKING.md](HACKING.md)
-
 ## Similar projects
 
 Many projects make setting up B.A.T.M.A.N. Advanced mesh networks with
 WiFi routers easier. They are easier to setup and are more
-configurable. But naxalnet is different from them. It simplifies
+configurable. But pybatmesh is different from them. It simplifies
 setting up mesh networks with _laptops or computers_, and was not
 made to work with routers.
 
-The following projects does something similar to naxalnet, but
+The following projects does something similar to pybatmesh, but
 requires special devices or routers to work. If you live in an area
 where the materials are easily available, consider using them instead
-of naxalnet.
+of pybatmesh.
 
 - [LibreMesh][]: framework for OpenWrt-based firmwares
 - [disaster.radio][]: solar-powered communications network
 
 ## License
 
-naxalnet is [free/libre/swatantra][free-sw] and open source software;
+pybatmesh is [free/libre/swatantra][free-sw] and open source 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,
-eitherversion 3 of the License, or (at your option) any later version.
+either version 3 of the License, or (at your option) any later version.
 
 See [LICENSE](LICENSE) for the complete version of the license.
 
@@ -313,17 +326,18 @@ See [LICENSE](LICENSE) for the complete version of the license.
 [ipfs]: https://ipfs.io "InterPlanetary File System"
 [jami]: https://jami.net "Peer to peer video calls"
 [ssb]: https://scuttlebutt.nz "Secure Scuttlebutt"
+[briar]: https://briarproject.org/
 [dasbus]: https://github.com/rhinstaller/dasbus "A python D-Bus library"
-[aur]: https://aur.archlinux.org/packages/naxalnet
+[aur]: https://aur.archlinux.org/packages/pybatmesh
-[aur-devel]: https://aur.archlinux.org/packages/naxalnet-git
+[aur-devel]: https://aur.archlinux.org/packages/pybatmesh-git
 [arch-resolved]: https://wiki.archlinux.org/title/Systemd-resolved#DNS "systemd-resolved on ArchWiki"
 [batman-systemd]: https://www.open-mesh.org/news/101 "systemd v248 brings support for batman advanced"
 [libremesh]: https://libremesh.org
 [disaster.radio]: https://disaster.radio
-[startnx]: #start-naxalnet
+[startnx]: #start-pybatmesh
 [iwd]: https://iwd.wiki.kernel.org "WiFi daemon"
 [free-sw]: https://gnu.org/philosophy/free-sw.html "What is free software?"
-[enablenx]: #running-at-boot
+[enable-pybatmesh]: #running-at-boot
 [requirements]: #requirements
 [install-manual]: #manually
 [python-systemd]: https://github.com/systemd/python-systemd

naxalnet.conf.example

@@ -1,23 +0,0 @@
-# This configuration file is part of naxalnet.
-# To configure this program, rename this file
-# to naxalnet.conf and edit it.
-# The values given here are defaults.
-
-[networkd]
-# systemd-networkd configuration files bundled with naxalnet.
-# THese will be copied to runtimedir at runtime.
-confdir = /usr/share/naxalnet/networkd
-# systemd-networkd runtime configuration directory.
-# See man:systemd.network(5)
-runtimedir = /run/systemd/network
-
-[adhoc]
-# All your nodes should have the same name
-name = NxMesh
-
-[ap]
-# An AP is started if your machine has more than one WiFi adapter.
-ssid = MeshWiFi
-# Note the spelling. It's passwd, not password.
-passwd = naxalnet256
-

naxalnet.service

@@ -1,40 +0,0 @@
-# The naxalnet systemd service
-# See man:systemd.service(5) and man:systemd.unit(5)
-# before editing this file.
-[Unit]
-Description=Setup mesh networks
-Requires=systemd-networkd.service
-Requires=iwd.service
-Wants=systemd-resolved.service
-After=iwd.service
-After=systemd-networkd.service
-After=systemd-resolved.service
-# Stops NetworkManager and wpa_supplicant if already running
-Conflicts=NetworkManager.service
-Conflicts=wpa_supplicant.service
-# This stops networkmanager and wpa_supplicant when naxalnet is enabled
-After=NetworkManager.service
-After=wpa_supplicant.service
-
-[Service]
-Type=notify
-NotifyAccess=all
-Restart=on-failure
-RestartSec=2sec
-ExecStart=/usr/bin/naxalnet --systemd
-# Reload systemd-networkd after naxalnet signals it is ready
-ExecStartPost=/usr/bin/networkctl reload
-# When naxalnet exits, delete all files starting
-# with mesh.* in /run/systemd/network
-ExecStopPost=/usr/bin/find /run/systemd/network -type f -delete -name "mesh.*"
-# Then delete the two interfaces created...
-ExecStopPost=/usr/bin/networkctl delete bridge0 bat0
-# ... and reload the configuration files.
-ExecStopPost=/usr/bin/networkctl reload
-# naxalnet already logs to systemd journal so we don't need
-# stdout and stderr.
-StandardOutput=null
-StandardError=null
-
-[Install]
-WantedBy=multi-user.target

naxalnet/default.py

@@ -1,40 +0,0 @@
-# This file is part of naxalnet.
-# Copyright (C) 2021 The naxalnet Authors
-
-# 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/>.
-
-"""
-default.py
-----------
-
-This file contains default values for configuration.
-This is taken as fallback data by config.py if no
-configuration files were found, or if a key-value pair
-was not present in the config file. The data will be
-further changed by arguments if naxalnet is called
-from the commandline. See config.py for more info.
-"""
-
-CONFIG = {
-    "networkd": {
-        "confdir": "/usr/share/naxalnet/networkd",
-        "runtimedir": "/run/systemd/network",
-    },
-    "adhoc": {"name": "NxMesh"},
-    "ap": {"ssid": "MeshWiFi", "passwd": "naxalnet256"},
-}
-
-# glob
-CONFIG_FILES = ["naxalnet.conf", "naxalnet.conf.d/*.conf"]
-CONFIG_DIRS = ["/usr/share/naxalnet", "/usr/local/share/naxalnet", "/etc/naxalnet"]

naxalnet/scripts.py

@@ -1,179 +0,0 @@
-# This file is part of naxalnet.
-# Copyright (C) 2021 The naxalnet Authors
-
-# 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/>.
-
-"""
-scripts.py
-----------
-
-The functions in this file is used for reading configs, args
-and doing the things this program is supposed to do.
-This file is named scripts.py because the original developer
-of this program could not think of a better name that suits this file.
-If you want to hack naxalnet, this is the right place to start.
-When run from the commandline, the function main() is called.
-"""
-
-import sys
-from pathlib import Path
-from shutil import copy
-from dasbus.error import DBusError
-from systemd.daemon import notify
-from naxalnet import __version__
-from naxalnet.log import logger
-from naxalnet.iwd import Adapter, Device, IWD
-from naxalnet.config import args
-from naxalnet.daemon import Daemon
-
-
-def copy_files():
-    """
-    Copy networkd configs to volatile dir.
-    The D-Bus API does not support creating new interfaces
-    or linking to bridges. So we use config files.
-    See man:systemd.network(5)
-    """
-    try:
-        notify("STATUS=Configuring the network...")
-        logger.info("Copying network config files")
-        dest = Path(args.networkd_runtime_dir)
-        src = Path(args.networkd_config_dir)
-
-        # Create the volatile directory if it doesn't exist
-        dest.mkdir(parents=True, exist_ok=True)
-
-        # Copy all files in src to dest
-        for i in src.iterdir():
-            copy(i, dest)
-    except PermissionError as error:
-        logger.error("Cannot copy file: %s", error)
-        sys.exit(3)
-
-
-def setup_devices():
-    """
-    Setup wifi interfaces using iwd
-    This function should be called every time an interface
-    is connected or removed.
-    """
-    try:
-        notify("STATUS=Setting up mesh...")
-        iwd = IWD()
-        devices = iwd.get_devices()
-        adhoc_devices = []
-        ap_devices = []
-
-        # Find devices supporting ad-hoc and ap
-        for i in devices:
-            # For each device, check if its adapter supports
-            # ad-hoc or ap. Many adapters will support both,
-            # so we will prioritise ad-hoc over ap.
-            device = Device(i)
-            logger.debug("Found device %s", device.name)
-            adapter = Adapter(device.adapter)
-            if adapter.supports_mode("ad-hoc"):
-                logger.debug("The device %s can be used for ad-hoc", device.name)
-                adhoc_devices.append(i)
-            if adapter.supports_mode("ap"):
-                logger.debug("The device %s can be used for ap", device.name)
-                ap_devices.append(i)
-
-        if len(adhoc_devices) != 0:
-            # Start ad-hoc on first device supporting ad-hoc
-            adhoc_device = Device(adhoc_devices.pop())
-            # The same device is likely to have ap support too.
-            # But we can't start ad-hoc and ap on the same interface.
-            # So we will remove adhoc_device from ap_devices if it exists there
-            if adhoc_device.name in ap_devices:
-                ap_devices.remove(adhoc_device.name)
-
-            # Turn on adapter if it is off
-            # See issue #9
-            adhoc_adapter = Adapter(adhoc_device.adapter)
-            if not adhoc_adapter.is_powered_on():
-                logger.debug("Adapter %s is off. Turning on", adhoc_adapter.name)
-                adhoc_adapter.power_on()
-            logger.info("Starting mesh on %s", adhoc_device.name)
-            adhoc_device.start_adhoc_open(args.adhoc_name)
-            # Start Access point if ap_device is not empty,
-            # ie, we have more devices
-            if len(ap_devices) != 0:
-                ap_device = Device(ap_devices.pop())
-                logger.info("Starting WiFi Access Point on %s", ap_device.name)
-                logger.info("Use naxalnet --print-wifi to get password")
-                # Turn on adapter if it is off
-                # See issue #9
-                ap_adapter = Adapter(ap_device.adapter)
-                if not ap_adapter.is_powered_on():
-                    logger.debug("Adapter %s is off. Turning on", ap_adapter.name)
-                    ap_adapter.power_on()
-                ap_device.start_ap(args.ap_ssid, args.ap_passwd)
-            else:
-                logger.warning("Not setting up WiFi AP.")
-        else:
-            logger.warning(
-                "No device found to setup mesh. Make sure a WiFi adapter is connected"
-            )
-
-    except DBusError:
-        logger.exception("Error while communicating with iwd")
-        sys.exit(4)
-
-
-def print_wifi():
-    """
-    Prints the name and password of the adhoc, and ap
-    from the arguments
-    """
-    print("Mesh name:", args.adhoc_name)
-    print("SSID:", args.ap_ssid)
-    print("Password:", args.ap_passwd)
-
-
-def print_version():
-    """Just does what the name suggests"""
-    print(__version__)
-
-
-def main():
-    """
-    This is where the magic happens!
-    This function is run every time you
-    execute naxalnet from the commandline
-    """
-
-    if args.print_wifi:
-        print_wifi()
-        sys.exit(0)
-    elif args.version:
-        print_version()
-        sys.exit(0)
-    copy_files()
-
-    setup_devices()
-    # Notify systemd that naxalnet is ready.
-    # see man:sd_notify(3)
-    notify("READY=1")
-
-    # Start the daemon so that setup_devices() is called every
-    # time a device is connected or removed.
-    daemon = Daemon()
-    daemon.add_callback(setup_devices)
-
-    notify("STATUS=Waiting for changes")
-    daemon.start()
-
-    # naxalnet prints Bye while exiting.
-    logger.info("Bye")

network/mesh.01-batman.netdev

@@ -0,0 +1,13 @@
+# Create the BATMAN interface
+# See mesh.04-batman.network for configuration details
+[NetDev]
+Name={batdev}
+Description=BATMAN interface
+Kind=batadv
+
+# See man:systemd.netdev(5) § [BATMANADVANCED] SECTION OPTIONS
+[BatmanAdvanced]
+# This helps choose the best network when many nodes have a DHCP
+# server. See the B.A.T.M.A.N. documentation at
+# https://www.open-mesh.org/projects/batman-adv/wiki/Gateways
+GatewayMode={gateway_mode}

network/mesh.02-bridge.netdev

@@ -1,8 +1,8 @@
 # Create a bridge interface
 # The batman interface be will later linked to this bridge.
-# See 07-bridge.network to see how this bridge is configured
+# See mesh.07-bridge.network to see how this bridge is configured
 [NetDev]
-Name=bridge0
+Name={bridgedev}
 Description=Bridge
 Kind=bridge
 

network/mesh.03-wireless-ad-hoc.network

@@ -10,7 +10,7 @@ MTUBytes=1560
 
 [Network]
 Description=ad-hoc network connecting to other nodes
-BatmanAdvanced=bat0
+BatmanAdvanced={batdev}
 # This interface should not have any IP addresses assigned.
 # IP will be given later to the bridge
 DHCP=no

network/mesh.04-batman.network

@@ -1,11 +1,11 @@
 [Match]
-Name=bat0
+Name={batdev}
 
 [Network]
-Description=The BATMAN interface
+Description=Configuration for the BATMAN interface
-Bridge=bridge0
+Bridge={bridgedev}
 
-# like in 03-wireless-ad-hoc.network, this interface
+# like in mesh.03-wireless-ad-hoc.network, this interface
 # also shouldn't have IP address the address will
 # be assigned to the bridge
 DHCP=no

network/mesh.05-wireless-ap.network

@@ -1,17 +1,17 @@
 # This file links any interface in ap mode
 # to the bridge we created earlier.
 # To start an AP, connect two adapters to the computer
-# before starting naxalnet.service
+# before starting pybatmesh.service
 # This file won't do anything if an ap interface is not found.
 
 [Match]
 WLANInterfaceType=ap
 
 [Network]
-Description=Wireless AP
+Description=Configuration for Wireless AP
 
 # link the interface to the bridge
-Bridge=bridge0
+Bridge={bridgedev}
 
 # Like in the ad-hoc network and bat0, this interface
 # should not have any ip address assigned to it.

network/mesh.06-eth.network

@@ -0,0 +1,9 @@
+# This file bridges any ethernet device found
+# to the bridge made in mesh.02-bridge.netdev
+[Match]
+Name=en*
+Name=eth*
+
+[Network]
+Description=Connect ethernet to the bridge
+Bridge={bridgedev}

network/mesh.07-bridge.network

@@ -3,13 +3,15 @@
 # communicate with others devices
 
 [Match]
-Name=bridge0
+Name={bridgedev}
 
 [Network]
-# use DHCP to assign an IP
+Description=bridge to link non-batman machines
+# Use DHCP to assign an IP
 DHCP=yes
 
-# if DHCP fails, assign a random address
+# If DHCP fails, assign a random address. This is probably the default,
+# but we are specifying it anyway.
 LinkLocalAddressing=yes
 
 # LLMNR and MulticastDNS are used for hostname discovery

network/tmp.01-eth.network

@@ -0,0 +1,10 @@
+# This is used to check if any ethernet or USB ethernet ports
+# is connected to a router or some other device with a DHCP server.
+# After checking, this file is no longer needed.
+[Match]
+Name=eth*
+Name=en*
+
+[Network]
+Description=Check for ethernet connection
+DHCP=yes

pybatmesh.conf.example

@@ -0,0 +1,35 @@
+# This configuration file is part of pybatmesh.
+# To configure this program, rename this file
+# to pybatmesh.conf and edit it.
+# The values given here are defaults.
+
+[networkd]
+# systemd-networkd configuration files bundled with pybatmesh.
+# THese will be copied to runtimedir at runtime.
+confdir = /usr/share/pybatmesh/networkd
+# systemd-networkd runtime configuration directory.
+# See man:systemd.network(5)
+runtimedir = /run/systemd/network
+
+[device]
+# These are better left this way
+# Changing this won't do you any good, unless you have
+# other network configs that would mess things up.
+batman=bat0
+bridge=bridge0
+
+[gateway]
+# This helps users choose the best network when multiple machines
+# offer an internet connection, or to be more precise, a DHCP server
+# Allowed values: auto, server, client or off
+mode=auto
+
+[adhoc]
+# All your nodes should have the same name
+name = pybatmesh
+
+[ap]
+# An AP is started if your machine has more than one WiFi adapter.
+ssid = BatWiFi
+# Note the spelling. It's passwd, not password.
+passwd = pybatmesh256

pybatmesh.service

@@ -0,0 +1,30 @@
+# The pybatmesh systemd service
+# See man:systemd.service(5) and man:systemd.unit(5)
+# before editing this file.
+[Unit]
+Description=Setup mesh networks
+Requires=systemd-networkd.service
+Requires=iwd.service
+Wants=systemd-resolved.service
+After=iwd.service
+After=systemd-networkd.service
+After=systemd-resolved.service
+# Stops NetworkManager if already running
+Conflicts=NetworkManager.service
+# This stops NetworkManager when pybatmesh is enabled
+After=NetworkManager.service
+
+[Service]
+Type=notify
+NotifyAccess=all
+Restart=on-failure
+RestartSec=2sec
+ExecStart=pybatmesh --systemd
+KillSignal=SIGINT
+# pybatmesh already logs to systemd journal so we don't need
+# stdout and stderr.
+StandardOutput=null
+StandardError=null
+
+[Install]
+WantedBy=multi-user.target

pybatmesh/__init__.py

@@ -1,25 +1,32 @@
-# This file is part of naxalnet.
+# This file is part of pybatmesh.
-# Copyright (C) 2021 The naxalnet Authors
+# Copyright (C) 2021 The pybatmesh Authors
 
-# This program is free software: you can redistribute it and/or modify
+# This program is free software: you can redistribute it and/or modify it
-# it under the terms of the GNU General Public License as published by
+# under the terms of the GNU General Public License as published by the
-# the Free Software Foundation, either version 3 of the License, or
+# Free Software Foundation, either version 3 of the License, or (at your
-# (at your option) any later version.
+# option) any later version.
 
-# This program is distributed in the hope that it will be useful,
+# This program is distributed in the hope that it will be useful, but
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
-# GNU General Public License for more details.
+# Public License for more details.
 
-# You should have received a copy of the GNU General Public License
+# You should have received a copy of the GNU General Public License along
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+# with this program. If not, see <http://www.gnu.org/licenses/>.
 
 """
-naxalnet
+pybatmesh
 ========
 
 Create mesh networks with batman-adv, systemd-networkd and iwd.
-See README.md for documentation.
+
+See README.md and the docstrings for documentation. You can read
+documentaion in the python interpretor using something like the example
+given below.
+
+>>> help("pybatmesh")
+>>> help("pybatmesh.config")
+
 """
 
 # GUIDE FOR CHANGING __version__
@@ -35,4 +42,4 @@ See README.md for documentation.
 #
 # In case you forgot to change the version, skip the number
 # and put the next number in the next commit.
-__version__ = "0.4.0"
+__version__ = "0.5.3"

pybatmesh/__main__.py

@@ -1,5 +1,5 @@
-# This file is part of naxalnet.
+# This file is part of pybatmesh.
-# Copyright (C) 2021 The naxalnet Authors
+# Copyright (C) 2021 The pybatmesh Authors
 
 # 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
@@ -16,12 +16,15 @@
 
 
 """
-If called as python -m naxalnet, this file makes naxalnet run like
+__main__.py
+-----------
+
+If called as python -m pybatmesh, this file makes pybatmesh run like
 it was called from the commandline. Try:
-    python -m naxalnet --help
+    python -m pybatmesh --help
 """
 
-from naxalnet.scripts import main
+from pybatmesh.scripts import main
 
 if __name__ == "__main__":
     main()

pybatmesh/config.py

@@ -1,65 +1,62 @@
-# This file is part of naxalnet.
+# This file is part of pybatmesh.
-# Copyright (C) 2021 The naxalnet Authors
+# Copyright (C) 2021 The pybatmesh Authors
 
-# This program is free software: you can redistribute it and/or modify
+# This program is free software: you can redistribute it and/or modify it
-# it under the terms of the GNU General Public License as published by
+# under the terms of the GNU General Public License as published by the
-# the Free Software Foundation, either version 3 of the License, or
+# Free Software Foundation, either version 3 of the License, or (at your
-# (at your option) any later version.
+# option) any later version.
 
-# This program is distributed in the hope that it will be useful,
+# This program is distributed in the hope that it will be useful, but
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
-# GNU General Public License for more details.
+# Public License for more details.
 
-# You should have received a copy of the GNU General Public License
+# You should have received a copy of the GNU General Public License along
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+# with this program. If not, see <http://www.gnu.org/licenses/>.
 
 """
 config.py
 ---------
 
-This file contains functions to parse configuration files
+This file contains functions to parse configuration files and arguments.
-and arguments. Most of these functions are meant to be used
+Most of these functions are meant to be used by parse_args() internally,
-by parse_args() internally, so only parse_args() should
+so only parse_args() should be imported outside this file.
-be imported outside this file.
 
-Some parts of naxalnet can be configured by configuration
+Some parts of pybatmesh can be configured by configuration files and
-files and arguments. First, the default values from
+arguments in a specific order. First, the default values from default.py
-default.py is taken. Then, key-value pairs from the
+is taken. Then, key-value pairs from the configuration files are read, if
-configuration files are read, if they exist, in the
+they exist, in the following order:
-following order:
 
-- First it reads /usr/share/naxalnet/naxalnet.conf
+- First it reads /usr/share/pybatmesh/pybatmesh.conf and then from
-  and then from /usr/share/naxalnet/naxalnet.conf.d/*.conf
+  /usr/share/pybatmesh/pybatmesh.conf.d/*.conf where *.conf means any file
-  where *.conf means any file with the name ending with
+  with the name ending with ".conf". The files in this directory are
-  ".conf". The files in this directory are intended
+  intended to be used by distribution and package maintainers.
-  to be used by distribution and package maintainers.
+
-- Next, it does the same with /usr/local/share/naxalnet
+- Next, it does the same with /usr/local/share/pybatmesh
-- Then, it looks for the files naxalnet.conf and
+
-  naxalnet.conf.d/*.conf from the directory
+- Then, it looks for the files pybatmesh.conf and pybatmesh.conf.d/*.conf
-  /etc/naxalnet, like it did up above. This directory is where
+  from the directory /etc/pybatmesh, like it did up above. This directory
-  the user creates and stores the config file.
+  is where the user creates and stores the config file.
-- Then it parses the arguments from the commandline,
+
-  storing the values in the files parsed until now
+- Then it parses the arguments from the commandline, storing the values in
-  as fallback. Finally you get an argpase.Namespace object
+  the files parsed until now as fallback. Finally you get an
-  from parse_args().
+  argpase.Namespace object from parse_args(). Because of the way this is
-  Because of the way this is implemented, all key-value
+  implemented, all key-value pairs in the configuration should have an
-  pairs in the configuration should have an argument
+  argument too, or they won't be parsed.
-  too, or they won't be parsed.
+
+All the key-value pairs are replaced successively if they exist by each
+new configuration file parsed, similar to how systemd parses configuration
+and service files. If any of the files checked does not exist, then they
+are ignored and the next combination is checked. If none of the config
+files exist and no arguments are given, the fallback data from default.py
+is used.
 
-All the key-value pairs are replaced successively if they exist
-by each new configuration file parsed, similar
-to how systemd parses configuration and service files.
-If any of the files checked does not exist, then they are
-ignored and the next combination is checked. If none of
-the config files exist and no arguments are given, the
-fallback data from default.py is used.
 """
 
 from pathlib import Path
 from configparser import ConfigParser
 from argparse import ArgumentParser, Namespace
-from naxalnet.default import CONFIG, CONFIG_FILES, CONFIG_DIRS
+from pybatmesh.default import CONFIG, CONFIG_FILES, CONFIG_DIRS
 
 
 def get_config_files():
@@ -99,7 +96,7 @@ def parse_args() -> Namespace:
     """
     Parse all arguments and return ArgumentParser.parse_args(),
     with values in config files as fallback. Ideally, only this
-    function should be used by naxalnet to get arguments and
+    function should be used by pybatmesh to get arguments and
     configuration.
     """
     config = parse_config()
@@ -158,6 +155,24 @@ def parse_args() -> Namespace:
         help="send log messages to systemd journal",
     )
 
+    parser.add_argument(
+        "--batman-device",
+        default=config["device"]["batman"],
+        help="name of interface used by batman-adv",
+    )
+
+    parser.add_argument(
+        "--bridge-device",
+        default=config["device"]["bridge"],
+        help="name of bridge interface",
+    )
+
+    parser.add_argument(
+        "--gateway-mode",
+        default=config["gateway"]["mode"],
+        help="auto, server, client, or off",
+    )
+
     parser.add_argument(
         "--version",
         "-V",
@@ -170,8 +185,10 @@ def parse_args() -> Namespace:
         "-v", "--verbose", action="count", default=0, help="increase output verbosity"
     )
 
-    # logger.debug("Parsing arguments")
     return parser.parse_args()
 
 
+# This is defined here because log.py needs some arguments to determine
+# the loglevel and where to send the log message to. If you know a better
+# way of implementing it, create an issue
 args = parse_args()

pybatmesh/daemon.py

@@ -1,29 +1,30 @@
-# This file is part of naxalnet.
+# This file is part of pybatmesh.
-# Copyright (C) 2021 The naxalnet Authors
+# Copyright (C) 2021 The pybatmesh Authors
 
-# This program is free software: you can redistribute it and/or modify
+# This program is free software: you can redistribute it and/or modify it
-# it under the terms of the GNU General Public License as published by
+# under the terms of the GNU General Public License as published by the
-# the Free Software Foundation, either version 3 of the License, or
+# Free Software Foundation, either version 3 of the License, or (at your
-# (at your option) any later version.
+# option) any later version.
 
-# This program is distributed in the hope that it will be useful,
+# This program is distributed in the hope that it will be useful, but
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
-# GNU General Public License for more details.
+# Public License for more details.
 
-# You should have received a copy of the GNU General Public License
+# You should have received a copy of the GNU General Public License along
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+# with this program. If not, see <http://www.gnu.org/licenses/>.
 
 """
 daemon.py
 ---------
 
-The daemon part. This is currently under construction.
+The daemon part. This is used to perform some work when a new wifi adapter
+is plugged in, or it is removed.
 """
 
 from dasbus.loop import EventLoop
-from naxalnet.iwd import IWD, IWD_DEVICE_INTERFACE
+from pybatmesh.iwd import IWD, IWD_DEVICE_INTERFACE
-from naxalnet.log import logger
+from pybatmesh.log import logger
 
 
 class Daemon:
@@ -32,13 +33,14 @@ class Daemon:
     def __init__(self):
         self.loop = EventLoop()
         self.iwd = IWD()
+        self.callback = None
 
     def on_device_add(self, path, data):
         """
         this function will be run every time a device is added
         """
         if IWD_DEVICE_INTERFACE in data:
-            logger.debug("New device %s found", str(data[IWD_DEVICE_INTERFACE]["Name"]))
+            logger.debug("New device %s found", data[IWD_DEVICE_INTERFACE]["Name"])
             logger.info("Reloading")
             self.callback()
 

pybatmesh/default.py

@@ -0,0 +1,50 @@
+# This file is part of pybatmesh.
+# Copyright (C) 2021 The pybatmesh Authors
+
+# 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/>.
+
+"""
+default.py
+----------
+
+This file contains default values for configuration. This is taken as
+fallback data by config.py if no configuration files were found, or if a
+key-value pair was not present in the config file. The data will be
+further changed by arguments if pybatmesh is called from the commandline.
+See config.py for more info.
+"""
+
+CONFIG = {
+    "networkd": {
+        "confdir": "/usr/share/pybatmesh/networkd",
+        "runtimedir": "/run/systemd/network",
+    },
+    "device": {"batman": "bat0", "bridge": "bridge0"},
+    "adhoc": {"name": "pybatmesh"},
+    "ap": {"ssid": "BatWiFi", "passwd": "pybatmesh256"},
+    "gateway": {"mode": "auto"},
+}
+
+# glob
+CONFIG_FILES = ["pybatmesh.conf", "pybatmesh.conf.d/*.conf"]
+CONFIG_DIRS = ["/usr/share/pybatmesh", "/usr/local/share/pybatmesh", "/etc/pybatmesh"]
+MESH_GLOB = "mesh.*"
+TMP_NET_GLOB = "tmp.*"
+
+ISSUE_URL = "https://git.disroot.org/pranav/pybatmesh/issues"
+REPORT_BUG_INFO = "If you think this is a bug, report it to " + ISSUE_URL
+
+# Changing this constant will alter not just the behaviour of pybatmesh,
+# but affect the meaning of Life, the Universe and Everthing
+ANSWER = 42

pybatmesh/iwd.py

@@ -1,64 +1,58 @@
-# This file is part of naxalnet.
+# This file is part of pybatmesh.
-# Copyright (C) 2021 The naxalnet Authors
+# Copyright (C) 2021 The pybatmesh Authors
 
-# This program is free software: you can redistribute it and/or modify
+# This program is free software: you can redistribute it and/or modify it
-# it under the terms of the GNU General Public License as published by
+# under the terms of the GNU General Public License as published by the
-# the Free Software Foundation, either version 3 of the License, or
+# Free Software Foundation, either version 3 of the License, or (at your
-# (at your option) any later version.
+# option) any later version.
 
-# This program is distributed in the hope that it will be useful,
+# This program is distributed in the hope that it will be useful, but
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
-# GNU General Public License for more details.
+# Public License for more details.
 
-# You should have received a copy of the GNU General Public License
+# You should have received a copy of the GNU General Public License along
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+# with this program. If not, see <http://www.gnu.org/licenses/>.
 
 """
 iwd.py
 ------
 
-This file contains methods to communicate with iwd via
+This file contains methods to communicate with iwd via its D-Bus API and
-its D-Bus API and control WiFi adapters.
+control WiFi adapters.
 
-Some terms used here, such as device and adapter might
+Some terms used here, such as device and adapter might confuse you if you
-confuse you if you haven't used iwctl before.
+haven't used iwctl before. Just as a quick reference, here is a list of
-Just as a quick reference, here is a list of terms
+terms and what they mean:
-and what they mean:
 
-- ad-hoc: a mode supported by some WiFi adapters to
+- ad-hoc: a mode supported by some WiFi adapters to start a decentralised
-          start a decentralised network, where there
+          network, where there is no central point of failure.
-          is no central point of failure.
 
-- ap: a mode used to start a central access point
+- ap: a mode used to start a central access point so that other machines
-      so that other machines without naxalnet can
+      without pybatmesh can connect to the mesh. AP is also known as WiFi
-      connect to the mesh. AP is also known as
+      hotspot.
-      WiFi hotspot.
 
-- station: this is the mode most WiFi adapters use
+- station: this is the mode most WiFi adapters use by default. This mode
-           by default. This mode is used to connect to
+           is used to connect to an ap. pybatmesh DOES NOT use this mode.
-           an ap. naxalnet DOES NOT use this mode.
 
-- adapter: a physical WiFi chip or something similar
+- adapter: a physical WiFi chip or something similar that is present
-           that is present inside most laptops and phones
+           inside most laptops and phones or can be connected via USB to a
-           or can be connected via USB to a machine.
+           machine.
 
-- device: an interface provided by the kernel to control
+- device: an interface provided by the kernel to control an adapter. Some
-          an adapter. Some adapters can have multiple
+          adapters can have multiple devices so that you can start an ap
-          devices so that you can start an ap on one device
+          on one device and an ad-hoc on the other. By default, iwd starts
-          and an ad-hoc on the other. By default, iwd starts
           only one device each for one adapter.
 
-- machine: Since iwd uses the term device for a
+- machine: Since iwd uses the term device for a WiFi interface, we use the
-           WiFi interface, we use the word machine to
+           word machine to refer to a computer, or a laptop, or a phone.
-           refer to a computer, or a laptop, or a phone.
 
-- node: a machine that runs naxalnet and is therefore
+- node: a machine that runs pybatmesh and is therefore connected to the
-        connected to the mesh.
+        mesh.
 """
 
 from dasbus.connection import SystemMessageBus
-from naxalnet.log import logger
+from pybatmesh.log import logger
 
 IWD_BUS = "net.connman.iwd"
 IWD_ROOT_PATH = "/"
@@ -74,7 +68,7 @@ class IWD:
     """Manage iwd via dbus"""
 
     def __init__(self, bus=SystemMessageBus()):
-        # self._bus and self._proxy are meant for use only in this file
+        # self._bus and self._proxy are meant for use only in this submodule
         self._bus = bus
         self.reload()
 
@@ -95,9 +89,9 @@ class IWD:
         for i in device_paths:
             proxy = self._bus.get_proxy(IWD_BUS, i)
             if proxy.Name == name:
-                return i
+                # See comment in the function below
-            # If no devices were found, return None
+                path = i
-        return None
+        return path
 
     def get_adapter_path_from_name(self, name: str) -> str:
         """returns path of adapter as str"""
@@ -105,9 +99,10 @@ class IWD:
         for i in adapter_paths:
             proxy = self._bus.get_proxy(IWD_BUS, i)
             if proxy.Name == name:
-                return i
+                # We could have just used return here, but shutting up
-            # If no adapters were found
+                # pylint has a greter priority at the moment
-        return None
+                path = i
+        return path
 
     def get_all_device_paths(self) -> list:
         """returns list of paths of all devices"""
@@ -132,7 +127,8 @@ class IWD:
 
     def get_devices(self) -> list:
         """
-        returns list of device names as str
+        returns list of all device names as str
+
         example: ["wlan0", "wlan1"]
         """
         devices = []
@@ -146,6 +142,7 @@ class IWD:
     def get_adapters(self) -> list:
         """
         returns list of adapters
+
         example: ["phy0","phy1"]
         """
         adapters = []
@@ -160,6 +157,7 @@ class IWD:
 class Device:
     """
     control devices with iwd
+
     name: name of device (str)
     adapter: name of adapter (str)
     """
@@ -190,7 +188,10 @@ class Device:
         self.reload()
 
     def reload(self):
-        """reload the proxy after changing mode"""
+        """
+        Reload the proxy. Used liberally by other
+        members to work around errors
+        """
         self._proxy = self._bus.get_proxy(IWD_BUS, self._path)
         self.name = self._proxy.Name
         adapter_path = self._proxy.Adapter
@@ -235,16 +236,15 @@ class Device:
         if it isn't already on ad-hoc and power onn the device
         if it is off
         """
-        print("Starting adhoc", name)
+        # Stop adhoc if already started
+        self.stop_adhoc()
+
         if self.get_mode() != "ad-hoc":
             self.set_mode("ad-hoc")
 
         if not self.is_powered_on():
             self.power_on()
 
-        # Stop adhoc if already started
-        self.stop_adhoc()
-
         logger.debug("Starting ad-hoc on %s", self.name)
         self._proxy.StartOpen(name)
 
@@ -261,15 +261,16 @@ class Device:
         if it isn't already on ap and turning
         on the device if it is off
         """
+
+        # Stop ap if already started
+        self.stop_ap()
+
         if self.get_mode() != "ap":
             self.set_mode("ap")
 
         if not self.is_powered_on():
             self.power_on()
 
-        # Stop ap if already started
-        self.stop_ap()
-
         logger.debug("Starting ap on %s with ssid %s", self.name, ssid)
         self._proxy.Start(ssid, passwd)
 

pybatmesh/log.py

@@ -1,5 +1,5 @@
-# This file is part of naxalnet.
+# This file is part of pybatmesh.
-# Copyright (C) 2021 The naxalnet Authors
+# Copyright (C) 2021 The pybatmesh Authors
 
 # 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
@@ -18,22 +18,23 @@
 log.py
 ------
 
-Initialise the logger for other submodules to import. Do not
+Initialise the logger for other submodules to import. Do not import any
-import any submodules here except for naxallnet.config
+submodules here other than pybatmesh.config, which is needed to set the
+loglevel and to add the systemd journal handler
 """
 import logging
 from systemd.journal import JournalHandler
-from naxalnet.config import args
+from pybatmesh.config import args
 
 
 def get_logger():
     """
     Initialise the logger and return it.
-    This function is meant to be used only by naxalnet.log.
+    This function is meant to be used only by pybatmesh.log.
     If you want to import the logger, use:
-    from naxalnet.log import logger
+    from pybatmesh.log import logger
     """
-    log = logging.getLogger("naxalnet")
+    log = logging.getLogger("pybatmesh")
     # --verbose
     if args.verbose >= 2:
         loglevel = logging.DEBUG

pybatmesh/network.py

@@ -0,0 +1,187 @@
+# This file is part of pybatmesh.
+# Copyright (C) 2021 The pybatmesh Authors
+
+# 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/>.
+
+"""
+network.py
+----------
+
+This submodule manages the systemd-networkd configuration. This is used to
+add configuration files to the systemd-networkd runtime directory.
+
+Some configuration files have variables which should be substituted by
+str.format() in python. The values for these variables can be set using
+NetworkD.set_vars(). See files in the systemd-networkd directory for
+examples.
+"""
+
+import subprocess
+from pathlib import Path
+from dasbus.connection import SystemMessageBus
+from dasbus.loop import EventLoop, GLib
+
+
+NETWORKD_BUS = "org.freedesktop.network1"
+NETWORKD_PATH = "/org/freedesktop/network1"
+
+
+class NetworkD:
+    """
+    Control systemd-networkd using configuration files. Since these
+    were made for use by pybatmesh only, the class is not suitable for
+    importing outside pybatmesh.
+    """
+
+    def __init__(self, runtime_dir="/run/systemd/network", bus=SystemMessageBus()):
+        print("NetworkD init")
+        self._bus = bus
+        self.proxy_reload()
+
+        self.variables = {}
+        self.runtime_path = Path(runtime_dir)
+        # Create the runtime directory if it doesn't exist
+        self.runtime_path.mkdir(parents=True, exist_ok=True)
+
+    def set_vars(self, **variables):
+        """set the variables to replace with str.format"""
+        self.variables = variables
+
+    def proxy_reload(self) -> None:
+        """reload the proxy"""
+        self.proxy = self._bus.get_proxy(NETWORKD_BUS, NETWORKD_PATH)
+
+    def reload(self) -> None:
+        """
+        Reload the systemd-networkd configuration. This is used by many
+        class methods after doing their job.
+        """
+        self.proxy.Reload()
+
+    def add_config(self, name: str) -> None:
+        """add config file to runtime directory and reload networkd"""
+        source = Path(name)
+        destination = self.runtime_path / source.name
+
+        # Substitute variables in the config
+        text = source.read_text(encoding="utf-8").format(**self.variables)
+        # now write it to a runtime config of the same name
+        destination.write_text(text, encoding="utf-8")
+        self.reload()
+
+    def is_routable(self) -> bool:
+        """returns true if any interface is routable"""
+        return self.proxy.AddressState == "routable"
+
+    def delete_interface(self, name: str) -> None:
+        """delete the given interface"""
+        # If anyone knows a better way of doing this, create
+        # an issue and get things done
+        subprocess.run(["networkctl", "delete", name], check=True)
+        # This is probably not required. This is mainly to shut up
+        # pylint's messages
+        self.reload()
+
+    def disable_config(self, name: str) -> None:
+        """
+        Disable or mask the config of the same name. This can only be
+        used for configs in /usr/lib/systemd/network and
+        /usr/local/lib/systemd/network. It works on the same principle
+        used by systemctl mask, that is, it created a symlink of the same
+        name in the runtime directory and links it to /dev/null.
+        """
+        path = self.runtime_path / name
+        path.symlink_to("/dev/null")
+        self.reload()
+
+    def remove_config(self, name: str) -> None:
+        """
+        remove the file called 'name' from the runtime dir and reload
+        """
+        path = self.runtime_path / name
+        path.unlink()
+        self.reload()
+
+    def remove_all_configs(self) -> None:
+        """
+        Remove all configs in runtime_path. This will remove all files
+        in runtime_path without checking who put them there.
+        """
+        for i in self.runtime_path.iterdir():
+            self.remove_config(i.name)
+
+
+class NetworkLoop(NetworkD):
+    """Used to wait until a condition is met
+
+    Available methods:
+
+    NetworkLoop.wait_until_routable(timeout=0):
+        return true when the network is routable, or false when timed out
+
+    """
+
+    def __init__(self, *args, **kwargs):
+        # first, initialise the parent object
+        super().__init__(*args, **kwargs)
+        self.waitfor = None
+        self.wait_function = None
+        self.loop = EventLoop()
+
+    def start_loop(self):
+        """start the dasbus loop"""
+        self.proxy.PropertiesChanged.connect(self.on_properties_changed)
+        self.loop.run()
+
+    def wait_until_routable(self, timeout=0):
+        """
+        Wait until timeout in milliseconds and returns True when any
+        network interface is shown routable by networkd. Does not wait
+        for timeout if timeout==0
+        """
+        self.setup_timeout(timeout)
+        self.wait_for_change("AddressState", self.on_addressstate_change)
+
+        return self.is_routable()
+
+    def wait_for_change(self, name, function):
+        """
+        Wait until the given property is changed and stop. If setup_timeout()
+        is called before calling this function, the loop stops after the timeout
+        or after the property is changed, whichever occurs first.
+        """
+        self.waitfor = name
+        self.wait_function = function
+        self.start_loop()
+
+    def on_addressstate_change(self):
+        """quit the loop if the network is routable"""
+        if self.is_routable():
+            self.loop.quit()
+
+    def on_properties_changed(self, bus_interface, data, blah):
+        """called by dasbus everytime the configured property is changed"""
+        if self.waitfor in data:
+            return self.wait_function()
+        # Just to shut up pylint
+        return None
+
+    def setup_timeout(self, timeout):
+        """setup a timeout"""
+        if timeout != 0:
+            GLib.timeout_add(timeout, self.on_timeout)
+
+    def on_timeout(self):
+        """called by dasbus when a timeout occurs"""
+        self.loop.quit()

pybatmesh/scripts.py

@@ -0,0 +1,271 @@
+# This file is part of pybatmesh.
+# Copyright (C) 2021 The pybatmesh Authors
+
+# 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/>.
+
+"""
+scripts.py
+----------
+
+The functions in this file is used for reading configs, args
+and doing the things this program is supposed to do.
+This file is named scripts.py because the original developer
+of this program could not think of a better name that suits this file.
+If you want to hack pybatmesh, this is the right place to start.
+When run from the commandline, the function main() is called.
+"""
+
+import sys
+from pathlib import Path
+from dasbus.error import DBusError
+from systemd.daemon import notify
+from pybatmesh import __version__
+from pybatmesh.default import REPORT_BUG_INFO, MESH_GLOB, TMP_NET_GLOB
+from pybatmesh.log import logger
+from pybatmesh.iwd import Adapter, Device, IWD
+from pybatmesh.config import args
+from pybatmesh.daemon import Daemon
+from pybatmesh.network import NetworkD, NetworkLoop
+
+
+def get_sorted_glob(directory: str, glob: str) -> list:
+    """return sorted list of filenames matching glob"""
+    path = Path(directory)
+    glob_list = path.glob(glob)
+    sorted_list = []
+    for i in glob_list:
+        # g is a list of PosixPath objects.
+        # So we add their absolute path as str.
+        sorted_list.append(str(i))
+    # sorted_list is not sorted, so we sort them here
+    sorted_list.sort()
+    return sorted_list
+
+
+def any_interface_is_routable():
+    """returns true if any of the interfaces is routable"""
+    networkd = NetworkLoop(runtime_dir=args.networkd_runtime_dir)
+
+    # First, add the temporary configs to networkd.
+    for i in get_sorted_glob(args.networkd_config_dir, TMP_NET_GLOB):
+        logger.debug("Adding temporary config %s", i)
+        networkd.add_config(i)
+
+    # timeout = 10 seconds
+    routable = networkd.wait_until_routable(10 * 1000)
+    networkd.remove_all_configs()
+
+    return routable
+
+
+def setup_mesh(gateway_mode: str = "off"):
+    """
+    configure networkd to setup the mesh
+
+    gateway_mode can be client, server, or off
+    """
+    try:
+        notify("STATUS=Configuring the network...")
+        logger.info("Copying network config files")
+
+        networkd = NetworkD(runtime_dir=args.networkd_runtime_dir)
+        networkd.set_vars(
+            batdev=args.batman_device,
+            bridgedev=args.bridge_device,
+            gateway_mode=gateway_mode,
+        )
+
+        # Fix for issue #19. There should be a switch to disable this
+        # humanitarian intervention. We don't want to adopt the U.S.
+        # foreign policy here.
+        networkd.disable_config("80-wifi-adhoc.network")
+
+        for i in get_sorted_glob(args.networkd_config_dir, MESH_GLOB):
+            logger.debug("Adding network config %s", i)
+            networkd.add_config(i)
+    except PermissionError:
+        logger.exception(
+            "A PermissionError occured while copying files. Make sure you are root."
+        )
+        logger.error(REPORT_BUG_INFO)
+        sys.exit(3)
+    except:
+        logger.exception("An unknown error occured while copying files")
+        logger.error(REPORT_BUG_INFO)
+        sys.exit(3)
+
+
+def setup_devices():
+    """
+    Setup wifi interfaces using iwd
+    This function should be called every time an interface
+    is connected or removed.
+    """
+    try:
+        notify("STATUS=Setting up mesh...")
+        iwd = IWD()
+        devices = iwd.get_devices()
+        adhoc_devices = []
+        ap_devices = []
+
+        # Find devices supporting ad-hoc and ap
+        for i in devices:
+            # For each device, check if its adapter supports
+            # ad-hoc or ap. Many adapters will support both,
+            # so we will prioritise ad-hoc over ap.
+            device = Device(i)
+            logger.debug("Found device %s", device.name)
+            adapter = Adapter(device.adapter)
+            if adapter.supports_mode("ad-hoc"):
+                logger.debug("The device %s can be used for ad-hoc", device.name)
+                adhoc_devices.append(i)
+            if adapter.supports_mode("ap"):
+                logger.debug("The device %s can be used for ap", device.name)
+                ap_devices.append(i)
+
+        if len(adhoc_devices) != 0:
+            # Start ad-hoc on first device supporting ad-hoc
+            adhoc_device = Device(adhoc_devices.pop())
+            # The same device is likely to have ap support too.
+            # But we can't start ad-hoc and ap on the same interface.
+            # So we will remove adhoc_device from ap_devices if it exists there
+            if adhoc_device.name in ap_devices:
+                ap_devices.remove(adhoc_device.name)
+
+            # Turn on adapter if it is off
+            # See issue #9
+            adhoc_adapter = Adapter(adhoc_device.adapter)
+            if not adhoc_adapter.is_powered_on():
+                logger.debug("Adapter %s is off. Turning on", adhoc_adapter.name)
+                adhoc_adapter.power_on()
+
+            logger.info("Starting mesh on %s", adhoc_device.name)
+            adhoc_device.start_adhoc_open(args.adhoc_name)
+
+            # Start Access point if ap_device is not empty,
+            # ie, we have more devices
+            if len(ap_devices) != 0:
+                ap_device = Device(ap_devices.pop())
+                logger.info("Starting WiFi Access Point on %s", ap_device.name)
+                logger.info("Use pybatmesh --print-wifi to get password")
+                # Turn on adapter if it is off
+                # See issue #9
+                ap_adapter = Adapter(ap_device.adapter)
+                if not ap_adapter.is_powered_on():
+                    logger.debug("Adapter %s is off. Turning on", ap_adapter.name)
+                    ap_adapter.power_on()
+                ap_device.start_ap(args.ap_ssid, args.ap_passwd)
+            else:
+                logger.warning("Not setting up WiFi AP.")
+        else:
+            logger.warning(
+                "No device found to setup mesh. Make sure a WiFi adapter is connected"
+            )
+
+    except DBusError:
+        logger.exception("Error while communicating with iwd")
+        logger.error(REPORT_BUG_INFO)
+        sys.exit(4)
+    except:
+        logger.exception("An unknown error occured while setting up the mesh")
+        logger.error(REPORT_BUG_INFO)
+        sys.exit(4)
+
+
+def cleanup():
+    """
+    Remove all network config, poweroff used wireless devices and
+    exit with 0.
+    """
+    networkd = NetworkD(runtime_dir=args.networkd_runtime_dir)
+    logger.info("Exiting gracefully")
+    networkd.remove_all_configs()
+    for i in IWD().get_devices():
+        logger.debug("Turning off %s", i)
+        device = Device(i)
+        # device.set_mode("station")
+        device.power_off()
+    logger.debug("Deleting interface %s", args.batman_device)
+    networkd.delete_interface(args.batman_device)
+    logger.debug("Deleting interface %s", args.bridge_device)
+    networkd.delete_interface(args.bridge_device)
+
+
+def print_wifi():
+    """
+    Prints the name and password of the adhoc, and ap
+    from the arguments
+    """
+    print("Mesh name:", args.adhoc_name)
+    print("SSID:", args.ap_ssid)
+    print("Password:", args.ap_passwd)
+
+
+def print_version():
+    """Just does what the name suggests"""
+    print(__version__)
+
+
+def main():
+    """
+    This is where the magic happens!
+    This function is run every time you
+    execute pybatmesh from the commandline
+    """
+
+    if args.print_wifi:
+        print_wifi()
+        sys.exit(0)
+    elif args.version:
+        print_version()
+        sys.exit(0)
+
+    # Notify systemd that pybatmesh is ready.
+    # see man:sd_notify(3)
+    notify("READY=1")
+
+    # Gateway mode comes in handy when many nodes have a DHCP server and
+    # you want to prevent conflicts. It defaults to "auto" in pybatmesh.
+    # https://www.open-mesh.org/projects/batman-adv/wiki/Gateways
+    if args.gateway_mode == "auto":
+        logger.info("Checking for internet connection")
+        notify("STATUS=Checking for internet")
+        # If any interface is routable, set gateway mode to server
+        if any_interface_is_routable():
+            logger.info("Network is routable. Setting gw_mode to server")
+            gateway_mode = "server"
+        else:
+            logger.info("Network is not routable. Setting gw_mode to client")
+            gateway_mode = "client"
+        logger.info("gateway_mode set to %s", gateway_mode)
+    elif args.gateway_mode in ["server", "client", "off"]:
+        gateway_mode = args.gateway_mode
+    else:
+        logger.error("gateway-mode has an illegal value")
+        sys.exit(5)
+
+    try:
+        setup_devices()
+        setup_mesh(gateway_mode=gateway_mode)
+
+        # Start the daemon so that setup_devices() is called every
+        # time a device is connected or removed.
+        daemon = Daemon()
+        daemon.add_callback(setup_devices)
+
+        notify("STATUS=Waiting for changes")
+        daemon.start()
+    # systemd uses SIGINT to kill this program
+    except KeyboardInterrupt:
+        cleanup()

pyproject.toml

@@ -1,3 +1,4 @@
 [build-system]
+# I don't know what this means, I just copied it from some setuptools tutorial
 requires = ["setuptools", "wheel"]
 build-backend = "setuptools.build_meta"

setup.cfg

@@ -1,9 +1,13 @@
+# This file is loosely based on the setup.cfg used in django.
+# pybatmesh is not meant to be distributed through PyPi. This program uses
+# a systemd service, and some other files whose path is hardcoded into the
+# module.
 [metadata]
-name = naxalnet
+name = pybatmesh
-version = attr: naxalnet.__version__
+version = attr: pybatmesh.__version__
 description = create mesh networks with batman-adv and systemd
 long_description = file: README.md
-url  = https://git.disroot.org/pranav/naxalnet
+url  = https://git.disroot.org/pranav/pybatmesh
 author = Pranav Jerry
 author_email = libreinator@disroot.org
 license = GPLv3
@@ -28,20 +32,21 @@ install_requires =
 
 [options.entry_points]
 console_scripts =
-    naxalnet = naxalnet.scripts:main
+    pybatmesh = pybatmesh.scripts:main
 
 [options.data_files]
 lib/systemd/system =
-    naxalnet.service
+    pybatmesh.service
 # If installing with pip, this file will be copied to some other place.
-# This is the reason we use setup.py instead of pip.
+# This is the reason we use setup.py instead of pip in the Makefile.
-/etc/naxalnet =
+/etc/pybatmesh =
-    naxalnet.conf.example
+    pybatmesh.conf.example
-share/naxalnet/networkd =
+share/pybatmesh/networkd =
-    systemd-networkd/mesh.01-batman.netdev
+    network/mesh.01-batman.netdev
-    systemd-networkd/mesh.02-bridge.netdev
+    network/mesh.02-bridge.netdev
-    systemd-networkd/mesh.03-wireless-ad-hoc.network
+    network/mesh.03-wireless-ad-hoc.network
-    systemd-networkd/mesh.04-batman.network
+    network/mesh.04-batman.network
-    systemd-networkd/mesh.05-wireless-ap.network
+    network/mesh.05-wireless-ap.network
-    systemd-networkd/mesh.06-eth.network
+    network/mesh.06-eth.network
-    systemd-networkd/mesh.07-bridge.network
+    network/mesh.07-bridge.network
+    network/tmp.01-eth.network

systemd-networkd/mesh.01-batman.netdev

@@ -1,10 +0,0 @@
-# Create the BATMAN interface
-# See 04-batman.network for configuration details
-[NetDev]
-Name=bat0
-Description=BATMAN interface
-Kind=batadv
-
-# Use default settings. Uncomment to change
-# see man:systemd.netdev(5) § [BATMANADVANCED] SECTION OPTIONS
-#[BatmanAdvanced]

systemd-networkd/mesh.06-eth.network

@@ -1,8 +0,0 @@
-# This file bridges any ethernet device found
-# to the bridge made in 02-bridge.netdev
-[Match]
-Name=en*
-Name=eth*
-
-[Network]
-Bridge=bridge0