├── .gitignore ├── .clang-format ├── .github ├── FUNDING.yml └── workflows │ ├── clang-format-check.yml │ └── build.yml ├── CMakeLists.txt ├── src ├── waybar.cpp ├── main.cpp ├── utils.cpp └── prayerTimings.cpp ├── README.md ├── include ├── utils.h ├── prayer_timings.h └── waybar.h └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | build/ 2 | .idea/ 3 | -------------------------------------------------------------------------------- /.clang-format: -------------------------------------------------------------------------------- 1 | # Google C++ Style clang-format 2 | --- 3 | Language: Cpp 4 | BasedOnStyle: Google 5 | ... 6 | -------------------------------------------------------------------------------- /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | # These are supported funding model platforms 2 | 3 | github: abdalrahmanshaban0 4 | patreon: # Replace with a single Patreon username 5 | open_collective: # Replace with a single Open Collective username 6 | ko_fi: # Replace with a single Ko-fi username 7 | tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel 8 | community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry 9 | liberapay: # Replace with a single Liberapay username 10 | issuehunt: # Replace with a single IssueHunt username 11 | lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry 12 | polar: # Replace with a single Polar username 13 | buy_me_a_coffee: abdalrahman 14 | thanks_dev: # Replace with a single thanks.dev username 15 | custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2'] 16 | -------------------------------------------------------------------------------- /.github/workflows/clang-format-check.yml: -------------------------------------------------------------------------------- 1 | name: Clang-Format Check 2 | 3 | on: 4 | pull_request: 5 | paths: 6 | - '**/*.cpp' 7 | - '**/*.hpp' 8 | - '**/*.h' 9 | - '**/*.cc' 10 | - '**/*.c' 11 | 12 | jobs: 13 | clang-format: 14 | runs-on: ubuntu-latest 15 | steps: 16 | - name: Checkout code 17 | uses: actions/checkout@v3 18 | 19 | - name: Install clang-format 20 | run: sudo apt-get install -y clang-format-14 21 | 22 | - name: Run clang-format check 23 | run: | 24 | files=$(git diff --name-only origin/${{ github.base_ref }} | grep -E '\.((cpp)|(hpp)|(cc)|(c)|(h))$' || true) 25 | if [ -n "$files" ]; then 26 | echo "Checking formatting..." 27 | clang-format-14 --dry-run --Werror $files 28 | else 29 | echo "No C++ files to check." 30 | fi 31 | -------------------------------------------------------------------------------- /CMakeLists.txt: -------------------------------------------------------------------------------- 1 | cmake_minimum_required(VERSION 3.31.6) 2 | project(Islamic_Prayer_Timings) 3 | 4 | # Set the C++ standard to C++20 5 | set(CMAKE_CXX_STANDARD 20) 6 | 7 | # Add the executable target (name = islamic-prayer-timings) 8 | add_executable(islamic-prayer-timings 9 | src/main.cpp 10 | include/utils.h 11 | src/utils.cpp 12 | include/prayer_timings.h 13 | src/prayerTimings.cpp 14 | include/waybar.h 15 | src/waybar.cpp 16 | ) 17 | 18 | # Find CURL and libnotify 19 | find_package(CURL REQUIRED) 20 | 21 | # Find libnotify using pkg-config 22 | find_package(PkgConfig REQUIRED) 23 | pkg_check_modules(LIBNOTIFY REQUIRED libnotify) 24 | 25 | # Link the libraries 26 | target_link_libraries(islamic-prayer-timings CURL::libcurl ${LIBNOTIFY_LIBRARIES}) 27 | 28 | # Include libnotify headers 29 | target_include_directories(islamic-prayer-timings PRIVATE ${LIBNOTIFY_INCLUDE_DIRS}) 30 | -------------------------------------------------------------------------------- /.github/workflows/build.yml: -------------------------------------------------------------------------------- 1 | # .github/workflows/build.yml 2 | name: Build 3 | 4 | on: 5 | pull_request: 6 | 7 | jobs: 8 | build: 9 | name: Build Project 10 | runs-on: ubuntu-latest 11 | 12 | steps: 13 | - name: Checkout code 14 | uses: actions/checkout@v3 15 | 16 | - name: Install build dependencies 17 | run: | 18 | sudo apt-get update 19 | sudo apt-get install -y cmake make g++ \ 20 | nlohmann-json3-dev \ 21 | libcurl4-openssl-dev \ 22 | libnotify-dev 23 | 24 | - name: Configure 25 | run: | 26 | mkdir build 27 | cd build 28 | cmake .. 29 | 30 | - name: Build 31 | run: | 32 | cd build 33 | make -j$(nproc) 34 | 35 | # Optional: Run tests if you have them 36 | # - name: Run tests 37 | # run: | 38 | # cd build 39 | # ctest --output-on-failure 40 | -------------------------------------------------------------------------------- /src/waybar.cpp: -------------------------------------------------------------------------------- 1 | #include 2 | #include 3 | #include 4 | #include 5 | #include 6 | #include 7 | 8 | #include "../include/utils.h" 9 | 10 | using namespace std; 11 | 12 | string formatTooltip(const vector& prayerTimings, const string& hijriDate, 13 | string names[6], const bool hour24) { 14 | string tooltip = hijriDate + "\n\n"; 15 | for (int i = 0; i < prayerTimings.size(); ++i) { 16 | ostringstream ss; 17 | ss << left << setw(10) << names[i] << setw(5) << ":" << right << setw(8) 18 | << (hour24 ? prayerTimings[i] : to12HourFormat(prayerTimings[i])) 19 | << (i+1 < prayerTimings.size() ? "\n" : ""); 20 | 21 | tooltip += ss.str(); 22 | } 23 | return tooltip; 24 | } 25 | 26 | void pipeToWayBar(const std::string& text, const std::string& tooltip) { 27 | using nlohmann::json; 28 | const json payload = {{"text", text}, {"tooltip", tooltip}}; 29 | std::cout << payload.dump() << std::endl; 30 | } -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Islamic-Prayer-timings 2 | See my post about this project in my technical blog [here](https://sudostart.com/islamic-prayer-timings-for-linux/) 3 | 4 |

5 | image 6 |

7 | 8 |

9 | image 10 |

11 | 12 |

13 | image 14 |

15 | 16 | ## Install on Arch-based distributions 17 | The project is available on the [AUR](https://aur.archlinux.org/packages/islamic-prayer-timings). To install it using AUR helper like `yay` or `paru`: 18 | ``` 19 | paru -S islamic-prayer-timings 20 | ``` 21 | 22 | 23 | ## Build and run 24 | ```shell 25 | git clone https://github.com/abdalrahmanshaban0/Islamic-Prayer-Timings/ 26 | 27 | cd Islamic-Prayer-Timings 28 | mkdir build 29 | cd build 30 | cmake .. 31 | make 32 | 33 | # non-daemon 34 | ./islamic-prayer-timings 35 | 36 | # daemon 37 | ./islamic-prayer-timings -d 38 | #OR 39 | ./islamic-prayer-timings --daemon 40 | ``` 41 | -------------------------------------------------------------------------------- /include/utils.h: -------------------------------------------------------------------------------- 1 | #ifndef UTILS_H 2 | #define UTILS_H 3 | 4 | #include 5 | #include 6 | 7 | /** 8 | * Convert seconds to HH:MM:SS format 9 | * @param total_seconds 10 | * @return time in HH:MM:SS format 11 | */ 12 | std::string seconds_to_HMS(int total_seconds); 13 | 14 | /** 15 | * Get the next prayer timing index and countdown until 16 | * @param prayerTimings vector of prayer timings of the day 17 | * @return Coming pray index and countdown until in seconds 18 | */ 19 | std::pair getNextPrayer( 20 | const std::vector& prayerTimings); 21 | 22 | /** 23 | * Checks if you're connected to internet or not 24 | * @return true if online, false if offline 25 | */ 26 | bool isInternetAvailable(); 27 | 28 | /** 29 | * Sends notification using libnotify for the current prayer provided 30 | * with prayer_name 31 | * @param prayer_name current prayer timing 32 | * @returns 0 on success and other positive integer on failure 33 | */ 34 | int send_prayer_notification(const std::string& prayer_name); 35 | 36 | /** 37 | * converts time from 24-hour format to 12-hour format 38 | * @param time24 time in 24-hour format 39 | * @return time in 12-hour format 40 | */ 41 | std::string to12HourFormat(const std::string& time24); 42 | 43 | /** 44 | * Runs a script at the given path. 45 | * @param scriptPath the absolute path of the script, if the path starts with 46 | * ~ will be handled. 47 | */ 48 | void runScript(const std::string& scriptPath); 49 | 50 | /** 51 | * Calculates seconds from now until midnight 52 | * @return Seconds until midnight 53 | */ 54 | int secondsUntilMidnight(); 55 | #endif 56 | -------------------------------------------------------------------------------- /include/prayer_timings.h: -------------------------------------------------------------------------------- 1 | #ifndef PRAYER_TIMINGS_H 2 | #define PRAYER_TIMINGS_H 3 | 4 | #include 5 | #include 6 | 7 | inline std::string names[] = {"Fajr", "Sunrise", "Dhuhr", 8 | "Asr", "Maghrib", "Isha"}; 9 | 10 | /** 11 | * Load the config ~/.config/IslamicPrayerTimings/config, if it doesn't exist 12 | * config-example will be created and loaded 13 | * @returns 0 on success and other positive value indicates an error 14 | */ 15 | int loadConfig(); 16 | 17 | /** 18 | * Gets prayer timings from the cached json response if it's found in 19 | * ~/.local/share/IslamicPrayerTimings/timings.json and assigns it to the 20 | * prayerTimings shared variable. This is useful when opening the system without 21 | * internet (load most recent timings). 22 | * @returns 0 on success and a positive integer on failure 23 | */ 24 | int loadCachedTimings(); 25 | 26 | /** 27 | * @brief Fetches Islamic prayer timings and the current Hijri date. 28 | * 29 | * Sends an HTTP GET request to the Aladhan API to retrieve today's prayer 30 | * times and Hijri date. The response is cached in 31 | * `~/.local/IslamicPrayerTimings/timings.json` so that it can be reused if 32 | * there is no internet connection on subsequent calls. 33 | * 34 | * @param[out] timings A vector that will be populated with the retrieved 35 | * prayer times (in order: Fajr, Sunrise, Dhuhr, Asr, 36 | * Maghrib, Isha). 37 | * @param[out] hdate A string that will be set to the corresponding Hijri 38 | * date. 39 | * 40 | * @return 0 on success, or a positive integer error code on failure 41 | * (e.g., network error, parse error, or cache read failure). 42 | */ 43 | int getTimings(std::vector& timings, std::string& hdate); 44 | 45 | /** 46 | * @brief Worker thread that keeps Islamic prayer timings and Hijri date up to 47 | * date. 48 | * 49 | * Runs an endless loop: 50 | * - Checks for internet connectivity (waits/retries if unavailable). 51 | * - Calls getTimings() to update shared data (prayerTimings, hijriDate, 52 | * waybarTooltip). 53 | * - Sleeps until a second past midnight, then repeats. 54 | * 55 | * @param[in] daemon A boolean that determines if timings get updated once or 56 | * periodically 57 | * This function never returns. 58 | */ 59 | void updateWorker(bool daemon); 60 | 61 | #endif 62 | -------------------------------------------------------------------------------- /include/waybar.h: -------------------------------------------------------------------------------- 1 | #ifndef ISLAMIC_PRAYER_TIMINGS_WAYBAR_H 2 | #define ISLAMIC_PRAYER_TIMINGS_WAYBAR_H 3 | 4 | #include 5 | #include 6 | 7 | /** 8 | * @brief Builds and returns a formatted tooltip string showing the Hijri date 9 | * and corresponding Islamic prayer times. 10 | * 11 | * Combines the given Hijri date and a list of prayer times into a single, 12 | * human-readable tooltip string. Each prayer time is printed on its own line, 13 | * preceded by its name, aligned in columns for readability. Times can be 14 | * shown in either 24-hour or 12-hour format, depending on the @p hour24 flag. 15 | * 16 | * @param[in] prayerTimings Vector of prayer times as strings 17 | * (order must match the @p names array). 18 | * @param[in] hijriDate Hijri date to display at the top of the tooltip. 19 | * @param[in] names Array of names corresponding to each prayer 20 | * (e.g., {"Fajr", "Sunrise", "Dhuhr", "Asr", 21 | * "Maghrib", "Isha"}). 22 | * @param[in] hour24 If `true`, display times in 24-hour format; 23 | * if `false`, convert them to 12-hour format using 24 | * `to12HourFormat()`. 25 | * 26 | * @return A formatted tooltip string that starts with the Hijri date 27 | * followed by each prayer name and its corresponding time, one per 28 | * line. 29 | * 30 | * @warning The function assumes that @p prayerTimings and @p names have the 31 | * same length. Supplying mismatched sizes leads to undefined behavior. 32 | */ 33 | std::string formatTooltip(const std::vector& prayerTimings, 34 | const std::string& hijriDate, std::string names[], 35 | bool hour24); 36 | 37 | /** 38 | * @brief Sends text and tooltip to Waybar in JSON format for a custom module. 39 | * 40 | * Constructs a minimal JSON object with two fields: 41 | * - `"text"`: the main content shown by the Waybar module 42 | * - `"tooltip"`: the text displayed on hover 43 | * 44 | * The result is printed to `stdout`, which Waybar reads from. 45 | * 46 | * @param text The main text to display in the Waybar module. 47 | * @param tooltip The tooltip content to show when hovering over the module. 48 | * 49 | * @note This function flushes the output immediately so Waybar can read it 50 | * without delay. 51 | */ 52 | void pipeToWayBar(const std::string& text, const std::string& tooltip); 53 | 54 | #endif // ISLAMIC_PRAYER_TIMINGS_WAYBAR_H 55 | -------------------------------------------------------------------------------- /src/main.cpp: -------------------------------------------------------------------------------- 1 | #include 2 | #include 3 | #include 4 | 5 | #include "../include/prayer_timings.h" 6 | #include "../include/utils.h" 7 | #include "../include/waybar.h" 8 | 9 | using namespace std; 10 | 11 | // Shared data 12 | vector prayerTimings; 13 | string waybarTooltip; 14 | string onAdhanScript; 15 | 16 | mutex dataMutex; 17 | 18 | const char* argv0; 19 | 20 | inline void printUsage() { cout << "Usage: " << argv0 << " [-d|--daemon]\n"; } 21 | 22 | auto ErrorInRed = "\033[31m[ERROR] \033[0m"; 23 | 24 | int main(const int argc, char* argv[]) { 25 | argv0 = argv[0]; 26 | bool daemon = false; 27 | 28 | if (argc > 2) { 29 | printUsage(); 30 | return 1; 31 | } 32 | if (argc == 2) { 33 | if (const string arg(argv[1]); arg == "-d" || arg == "--daemon") { 34 | daemon = true; 35 | } else { 36 | printUsage(); 37 | return 0; 38 | } 39 | } 40 | 41 | if (const int chk = loadConfig()) { 42 | cerr << ErrorInRed << "Loading config" << endl; 43 | return chk; 44 | } 45 | 46 | updateWorker(false); 47 | 48 | if (!daemon) { 49 | auto [nextPrayIdx, diff] = getNextPrayer(prayerTimings); 50 | const string nextPrayer = names[nextPrayIdx] + " " + seconds_to_HMS(diff); 51 | cout << "⠀⠀⣄⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⣠⠀⠀\n" 52 | "⠀⣰⣿⡄⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢠⣿⣆⠀\n" 53 | "⠠⠿⠿⠿⠀⠀⠀⠀⠀⠀⠀⠀⢀⡀⠀⠀⠀⠀⠀⠀⠀⠀⠿⠿⠿⠄\n" 54 | "⢰⣶⣶⣶⡄⠀⠀⠀⠀⣀⣴⣾⣿⣿⣷⣦⣀⠀⠀⠀⠀⢠⣶⣶⣶⡆\n" 55 | "⢸⣿⣿⣿⡇⠀⠀⢠⣾⣿⣿⣿⣿⣿⣿⣿⣿⣷⡄⠀⠀⢸⣿⣿⣿⡇\n" 56 | "⢸⣿⣿⣿⡇⠀⢠⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⡄⠀⢸⣿⣿⣿⡇\n" 57 | "⢸⣿⣿⣿⡇⠀⠈⢿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⡿⠁⠀⢸⣿⣿⣿⡇\n" 58 | "⢸⣿⣿⣿⡇⢰⣶⣾⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣷⣶⡆⢸⣿⣿⣿⡇\n" 59 | "⢸⣿⣿⣿⡇⢸⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⡇⢸⣿⣿⣿⡇\n" 60 | "⢸⣿⣿⣿⡇⢸⣿⣿⣿⣿⣿⠟⠁⠈⠻⣿⣿⣿⣿⣿⡇⢸⣿⣿⣿⡇\n" 61 | "⢸⣿⣿⣿⡇⢸⣿⣿⣿⣿⡏⠀⠀⠀⠀⢹⣿⣿⣿⣿⡇⢸⣿⣿⣿⡇\n" 62 | "⢸⣿⣿⣿⡇⢸⣿⣿⣿⣿⡇⠀⠀⠀⠀⢸⣿⣿⣿⣿⡇⢸⣿⣿⣿⡇\n" 63 | "⠸⠿⠿⠿⠇⠸⠿⠿⠿⠿⠇⠀⠀⠀⠀⠸⠿⠿⠿⠿⠇⠸⠿⠿⠿⠇\n"; 64 | 65 | cout << nextPrayer << '\n'; 66 | cout << waybarTooltip << endl; 67 | return 0; 68 | } 69 | 70 | std::thread t(updateWorker, true); 71 | t.detach(); 72 | 73 | while (true) { 74 | pair p; 75 | { 76 | std::lock_guard lock(dataMutex); 77 | p = getNextPrayer(prayerTimings); 78 | } 79 | 80 | int nextPrayIdx = p.first; 81 | int diff = p.second; 82 | 83 | while (diff > 0) { 84 | string waybarText = names[nextPrayIdx] + " " + seconds_to_HMS(diff); 85 | pipeToWayBar(waybarText, waybarTooltip); 86 | diff--; 87 | this_thread::sleep_for(1s); 88 | } 89 | 90 | if (nextPrayIdx != 1) { 91 | if (send_prayer_notification(names[nextPrayIdx])) { 92 | cerr << ErrorInRed << "Failed to send notification!" << endl; 93 | } 94 | runScript(onAdhanScript); 95 | } 96 | 97 | this_thread::sleep_for(1s); 98 | } 99 | } 100 | -------------------------------------------------------------------------------- /src/utils.cpp: -------------------------------------------------------------------------------- 1 | #include "../include/utils.h" 2 | 3 | #include 4 | 5 | #include 6 | #include 7 | 8 | using namespace std; 9 | namespace fs = std::filesystem; 10 | 11 | string seconds_to_HMS(const int total_seconds) { 12 | const int hours = total_seconds / 3600; 13 | const int minutes = (total_seconds % 3600) / 60; 14 | const int seconds = total_seconds % 60; 15 | string result = (hours < 10 ? "0" : "") + to_string(hours) + ":" + 16 | (minutes < 10 ? "0" : "") + to_string(minutes) + ":" + 17 | (seconds < 10 ? "0" : "") + to_string(seconds); 18 | return result; 19 | } 20 | 21 | pair getNextPrayer(const vector& prayerTimings) { 22 | pair nextPray; 23 | time_t now = time(nullptr); 24 | const tm* cur = localtime(&now); 25 | int cur_val = (cur->tm_min) * 60 + (cur->tm_hour) * 60 * 60 + (cur->tm_sec); 26 | int comming_val = 0, comming_idx = 0; 27 | for (int i = 0; i < 6; i++) { 28 | int secs = stoi(prayerTimings[i].substr(0, 2)) * 3600 + 29 | stoi(prayerTimings[i].substr(3, 2)) * 60; 30 | if (i == 0) comming_val = secs; 31 | if (secs > cur_val) { 32 | comming_idx = i; 33 | comming_val = secs; 34 | break; 35 | } 36 | } 37 | int diff = comming_val - cur_val; 38 | if (diff < 0) diff += 24 * 3600; 39 | return {comming_idx, diff}; 40 | } 41 | 42 | int send_prayer_notification(const string& prayer_name) { 43 | if (!notify_init("Islamic Prayer Notification")) { 44 | cerr << "Failed to initialize libnotify!" << endl; 45 | return 1; 46 | } 47 | // Create a new notification 48 | NotifyNotification* notification = notify_notification_new( 49 | "Islamic Prayer Timings", ("It's time for " + prayer_name).c_str(), 50 | "dialog-information"); 51 | 52 | // Display the notification 53 | if (!notify_notification_show(notification, nullptr)) { 54 | cerr << "Failed to display notification!" << endl; 55 | return 2; 56 | } 57 | // Free the notification object 58 | g_object_unref(G_OBJECT(notification)); 59 | // Shutdown libnotify 60 | notify_uninit(); 61 | return 0; 62 | } 63 | 64 | std::string to12HourFormat(const std::string& time24) { 65 | int hour, minute; 66 | char colon; 67 | 68 | std::istringstream iss(time24); 69 | iss >> hour >> colon >> minute; 70 | 71 | std::ostringstream oss; 72 | bool isPM = hour >= 12; 73 | int hour12 = hour % 12; 74 | if (hour12 == 0) hour12 = 12; 75 | 76 | oss << std::setw(2) << std::setfill('0') << hour12 << ":" << std::setw(2) 77 | << std::setfill('0') << minute << (isPM ? " PM" : " AM"); 78 | 79 | return oss.str(); 80 | } 81 | 82 | void runScript(const std::string& scriptPath) { 83 | if (fs::exists(scriptPath) && fs::is_regular_file(scriptPath) && 84 | access(scriptPath.c_str(), X_OK) == 0) { 85 | int result = system((scriptPath + " &").c_str()); 86 | if (result != 0) { 87 | cerr << "Script failed with exit code: " << result << endl; 88 | } 89 | } else { 90 | cerr << "Adhan script not found: " << scriptPath << endl; 91 | } 92 | } 93 | 94 | int secondsUntilMidnight() { 95 | using namespace std::chrono; 96 | 97 | auto now = system_clock::now(); 98 | time_t now_c = system_clock::to_time_t(now); 99 | std::tm* now_tm = std::localtime(&now_c); 100 | 101 | now_tm->tm_hour = 0; 102 | now_tm->tm_min = 0; 103 | now_tm->tm_sec = 0; 104 | now_tm->tm_mday += 1; // move to next day 105 | 106 | auto midnight = system_clock::from_time_t(std::mktime(now_tm)); 107 | auto diff = duration_cast(midnight - now); 108 | return static_cast(diff.count()); 109 | } 110 | -------------------------------------------------------------------------------- /src/prayerTimings.cpp: -------------------------------------------------------------------------------- 1 | #include 2 | 3 | #include 4 | #include 5 | #include 6 | #include 7 | #include 8 | 9 | #include "../include/prayer_timings.h" 10 | #include "../include/utils.h" 11 | #include "../include/waybar.h" 12 | using namespace std; 13 | using json = nlohmann::json; 14 | namespace fs = filesystem; 15 | 16 | // config variables 17 | static string country, city; 18 | static bool hour24; 19 | extern string onAdhanScript; 20 | 21 | extern vector prayerTimings; 22 | extern string waybarTooltip; 23 | 24 | extern mutex dataMutex; 25 | 26 | int loadConfig() { 27 | const char* homeEnv = std::getenv("HOME"); 28 | if (!homeEnv) { 29 | std::cerr << "HOME environment variable not set!\n"; 30 | return 1; 31 | } 32 | 33 | const std::string configDir = 34 | std::string(homeEnv) + "/.config/IslamicPrayerTimings"; 35 | const std::string configPath = configDir + "/config"; 36 | 37 | try { 38 | // If config does not exist, create it with default values 39 | if (!fs::exists(configPath)) { 40 | fs::create_directories(configDir); // ensure directory exists 41 | 42 | nlohmann::json defaultConfig = { 43 | {"country", "Egypt"}, 44 | {"city", "Cairo"}, 45 | {"hour24", false}, 46 | {"onAdhan", "~/.config/IslamicPrayerTimings/inAdhan.sh"}}; 47 | 48 | std::ofstream outFile(configPath); 49 | if (!outFile.is_open()) { 50 | std::cerr << "Failed to create default config file!\n"; 51 | return 2; 52 | } 53 | outFile << defaultConfig.dump(2); 54 | outFile.close(); 55 | 56 | std::cout << "Created default config at: " << configPath << '\n'; 57 | } 58 | } catch (const std::exception& e) { 59 | std::cerr << "Failed to prepare config: " << e.what() << '\n'; 60 | return 3; 61 | } 62 | 63 | // Load config 64 | std::ifstream configFile(configPath); 65 | if (!configFile.is_open()) { 66 | std::cerr << "Failed to open config file!\n"; 67 | return 4; 68 | } 69 | 70 | try { 71 | nlohmann::json configJson; 72 | configFile >> configJson; 73 | 74 | if (configJson.contains("country")) 75 | country = configJson["country"].get(); 76 | if (configJson.contains("city")) 77 | city = configJson["city"].get(); 78 | if (configJson.contains("hour24")) 79 | hour24 = configJson["hour24"].get(); 80 | if (configJson.contains("onAdhan")) 81 | onAdhanScript = configJson["onAdhan"].get(); 82 | 83 | // Expand ~ in onAdhan path 84 | if (!onAdhanScript.empty() && onAdhanScript[0] == '~') { 85 | onAdhanScript.replace(0, 1, homeEnv); 86 | } 87 | } catch (const std::exception& e) { 88 | std::cerr << "Error parsing config: " << e.what() << '\n'; 89 | return 5; 90 | } 91 | 92 | return 0; 93 | } 94 | 95 | int loadCachedTimings() { 96 | const char* homeEnv = std::getenv("HOME"); 97 | if (!homeEnv) { 98 | std::cerr << "HOME environment variable not set.\n"; 99 | return 1; 100 | } 101 | 102 | fs::path filePath = 103 | fs::path(homeEnv) / ".local/share/IslamicPrayerTimings/timings.json"; 104 | 105 | if (!fs::exists(filePath)) { 106 | return 2; 107 | } 108 | 109 | json j; 110 | try { 111 | std::ifstream inFile(filePath); 112 | if (!inFile.is_open()) { 113 | std::cerr << "Cannot open cache file: " << filePath << '\n'; 114 | return 3; 115 | } 116 | inFile >> j; 117 | } catch (const std::exception& e) { 118 | std::cerr << "Error reading JSON: " << e.what() << '\n'; 119 | return 4; 120 | } 121 | 122 | try { 123 | const auto& t = j.at("data").at("timings"); 124 | prayerTimings = { 125 | t.at("Fajr").get(), t.at("Sunrise").get(), 126 | t.at("Dhuhr").get(), t.at("Asr").get(), 127 | t.at("Maghrib").get(), t.at("Isha").get()}; 128 | } catch (const std::exception& e) { 129 | std::cerr << "Invalid JSON structure: " << e.what() << '\n'; 130 | return 5; 131 | } 132 | 133 | return 0; 134 | } 135 | 136 | static size_t WriteCallback(void* contents, const size_t size, 137 | const size_t nmemb, string* output) { 138 | const size_t totalSize = size * nmemb; 139 | output->append(static_cast(contents), totalSize); 140 | return totalSize; 141 | } 142 | 143 | int getTimings(std::vector& timings, std::string& hdate) { 144 | std::string readBuffer; 145 | 146 | // Initialize CURL 147 | CURL* curl = curl_easy_init(); 148 | if (!curl) { 149 | std::cerr << "Failed to initialize CURL\n"; 150 | return 1; 151 | } 152 | 153 | const std::string url = 154 | "https://api.aladhan.com/v1/timingsByCity?city=" + city + 155 | "&country=" + country; 156 | 157 | curl_easy_setopt(curl, CURLOPT_URL, url.c_str()); 158 | curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, WriteCallback); 159 | curl_easy_setopt(curl, CURLOPT_WRITEDATA, &readBuffer); 160 | curl_easy_setopt(curl, CURLOPT_FOLLOWLOCATION, 1L); 161 | 162 | if (const CURLcode res = curl_easy_perform(curl); res != CURLE_OK) { 163 | std::cerr << "Request failed: " << curl_easy_strerror(res) << '\n'; 164 | curl_easy_cleanup(curl); 165 | return 2; 166 | } 167 | 168 | curl_easy_cleanup(curl); 169 | 170 | try { 171 | const json j = json::parse(readBuffer); 172 | 173 | const char* home = std::getenv("HOME"); 174 | if (!home) { 175 | std::cerr << "HOME environment variable not set.\n"; 176 | return 3; 177 | } 178 | 179 | const std::string dirPath = 180 | std::string(home) + "/.local/share/IslamicPrayerTimings"; 181 | const std::string filePath = dirPath + "/timings.json"; 182 | 183 | std::filesystem::create_directories(dirPath); 184 | std::ofstream(filePath) << j.dump(2); 185 | 186 | const auto& t = j["data"]["timings"]; 187 | timings = {t["Fajr"].get(), t["Sunrise"].get(), 188 | t["Dhuhr"].get(), t["Asr"].get(), 189 | t["Maghrib"].get(), t["Isha"].get()}; 190 | 191 | const auto& hijri = j["data"]["date"]["hijri"]; 192 | hdate = hijri["day"].get() + " " + 193 | hijri["month"]["en"].get() + " " + 194 | hijri["year"].get(); 195 | } catch (const std::exception& e) { 196 | std::cerr << "JSON parse error: " << e.what() << '\n'; 197 | return 4; 198 | } 199 | 200 | return 0; 201 | } 202 | 203 | void updateWorker(const bool daemon) { 204 | while (true) { 205 | if (daemon) { 206 | const int sleepDuration = secondsUntilMidnight(); 207 | std::this_thread::sleep_for(std::chrono::seconds(sleepDuration + 1)); 208 | } 209 | 210 | std::vector newTimings; 211 | std::string newHijri; 212 | 213 | bool updated = true; 214 | 215 | if (const int result = getTimings(newTimings, newHijri); result == 0) { 216 | std::lock_guard lock(dataMutex); 217 | prayerTimings = std::move(newTimings); 218 | const string hijriDate = std::move(newHijri); 219 | waybarTooltip = formatTooltip(prayerTimings, hijriDate, names, hour24); 220 | } else { 221 | cerr << "Failed to update timings (error code " << result << ")\n"; 222 | if (const int chk = loadCachedTimings()) { 223 | if (chk == 2) { 224 | cerr << "No cached timings\n"; 225 | } else { 226 | cerr << "Failed to load cached timings! " << chk << endl; 227 | } 228 | } else { 229 | // Format the tooltip with the cached timings without hijriDate 230 | waybarTooltip = formatTooltip(prayerTimings, "NULL", names, hour24); 231 | if (!daemon) return; 232 | } 233 | // Error getting timings (mostly no Internet connection) 234 | updated = false; 235 | cerr << "Retrying in 10 minutes..." << endl; 236 | std::this_thread::sleep_for(std::chrono::minutes(10)); 237 | } 238 | if (!daemon && updated) return; 239 | } 240 | } 241 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------