Change the default location for database files to the data local dire…

…ctory (#17) * remove execute permission * Change the default location for database files to the data local directory #16 * fix: update gh ci Co-authored-by: qtfkwk <[email protected]> --------- Co-authored-by: qtfkwk <[email protected]> Co-authored-by: wiseaidev <[email protected]>
wiseaidev · May 7, 2024 · 4e78590 · 4e78590
1 parent ea5a9e8
commit 4e78590
Show file tree

Hide file tree

Showing 13 changed files with 23 additions and 29 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -17,7 +17,7 @@ jobs:
     steps:
     - uses: actions/checkout@v3
     - name: Curl
-      run: curl -LS https://raw.githubusercontent.com/wiseaidev/ipcap/main/data/geo_ip_city_v4.dat --create-dirs -o ~/ipcap/geo_ip_city_v4.dat && curl -LS https://raw.githubusercontent.com/wiseaidev/ipcap/main/data/geo_ip_city_v6.dat --create-dirs -o ~/ipcap/geo_ip_city_v6.dat
+      run: curl -LS https://raw.githubusercontent.com/wiseaidev/ipcap/main/data/geo_ip_city_v4.dat --create-dirs -o ~/.local/share/ipcap/geo_ip_city_v4.dat && curl -LS https://raw.githubusercontent.com/wiseaidev/ipcap/main/data/geo_ip_city_v6.dat --create-dirs -o ~/.local/share/ipcap/geo_ip_city_v6.dat
     - name: Build
       run: cargo build --verbose
     - name: Run tests

diff --git a/Cargo.toml b/Cargo.toml
diff --git a/LICENSE b/LICENSE
diff --git a/README.md b/README.md
@@ -46,13 +46,13 @@ Download the city databases, v4 and v6 from the repository using this command:
 
 ```sh
 # IPV4 database
-curl -LS https://raw.githubusercontent.com/wiseaidev/ipcap/main/data/geo_ip_city_v4.dat --create-dirs -o ~/ipcap/geo_ip_city_v4.dat
+curl -LS https://raw.githubusercontent.com/wiseaidev/ipcap/main/data/geo_ip_city_v4.dat --create-dirs -o ~/.local/share/ipcap/geo_ip_city_v4.dat
 
 # IPV6 database
-curl -LS https://raw.githubusercontent.com/wiseaidev/ipcap/main/data/geo_ip_city_v6.dat --create-dirs -o ~/ipcap/geo_ip_city_v6.dat
+curl -LS https://raw.githubusercontent.com/wiseaidev/ipcap/main/data/geo_ip_city_v6.dat --create-dirs -o ~/.local/share/ipcap/geo_ip_city_v6.dat
 ```
 
-This will download the `data/geo_ip_city_v4.dat` and or `data/geo_ip_city_v4.dat` database(s) from the repository and put it under `~/ipcap/`.
+This will download the `data/geo_ip_city_v4.dat` and or `data/geo_ip_city_v4.dat` database(s) from the repository and put it under `~/.local/share/ipcap/`.
 
 If, for some reason, you decide to change this file location, just set this environment variable to help the CLI read this file. To set the environment variable before running your Rust program, you can do something like:
 
@@ -66,6 +66,9 @@ export IPCAP_FILE_PATH=/your/custom/path/geo_ip_city_v6.dat
 
 Replace `/your/custom/path/geo_ip_city_v4.dat` with the desired file path. If the environment variable is not set, the program will use the default path (`/home/username/ipcap/geo_ip_city_v4.dat`).
 
+> [!NOTE]
+The default location to find the databases is `~/Library/Application Support/ipcap/` on macOS, and `C:\Users\Username\AppData\Local\ipcap\` on Windows.
+
 > [!NOTE]
 The databases were shamelessly taken from the fedora website at [https://src.fedoraproject.org/repo/pkgs/GeoIP-GeoLite-data/](https://src.fedoraproject.org/repo/pkgs/GeoIP-GeoLite-data/).
 

diff --git a/src/cli.rs b/src/cli.rs
diff --git a/src/constants.rs b/src/constants.rs
diff --git a/src/designated_market_area.rs b/src/designated_market_area.rs
diff --git a/src/errors.rs b/src/errors.rs
diff --git a/src/geo_ip_reader.rs b/src/geo_ip_reader.rs
@@ -4,10 +4,12 @@ use crate::designated_market_area::DesignatedMarketArea;
 use crate::errors::GeoIpReaderError;
 use crate::time_zones::time_zone_by_country;
 use crate::utils::{ip_to_number, read_data};
-use dirs::home_dir;
-use std::env;
-use std::fs::File;
-use std::io::{Read, Seek, SeekFrom};
+use std::{
+    env,
+    fs::File,
+    io::{Read, Seek, SeekFrom},
+    path::PathBuf,
+};
 
 /// `GeoIpReader` represents a reader for GeoIP databases, allowing the retrieval
 /// of information based on IP addresses.
@@ -73,32 +75,21 @@ where
     /// }
     /// ```
     pub fn new(type_: &str) -> Result<GeoIpReader<File>, GeoIpReaderError> {
-        const ENV_VAR_NAME: &str = "IPCAP_FILE_PATH";
-        let file_path = match env::var(ENV_VAR_NAME) {
-            Ok(val) => val,
-            Err(_) => {
-                let default_path = match type_ {
-                    "v4" => {
-                        let mut path = home_dir().unwrap_or_default();
-                        path.push("ipcap");
-                        path.push("geo_ip_city_v4.dat");
-                        path
-                    }
-                    "v6" => {
-                        let mut path = home_dir().unwrap_or_default();
-                        path.push("ipcap");
-                        path.push("geo_ip_city_v6.dat");
-                        path
-                    }
+        let file_path = match env::var("IPCAP_FILE_PATH") {
+            Ok(val) => PathBuf::from(val),
+            Err(_) => dirs::data_local_dir()
+                .expect("Failed to get the data local directory")
+                .join(env!("CARGO_PKG_NAME"))
+                .join(match type_ {
+                    "v4" => "geo_ip_city_v4.dat",
+                    "v6" => "geo_ip_city_v6.dat",
                     _ => {
                         return Err(GeoIpReaderError::OpenFileError);
                     }
-                };
-                default_path.to_string_lossy().into_owned()
-            }
+                }),
         };
 
-        let fp = File::open(&file_path).map_err(|_| GeoIpReaderError::OpenFileError)?;
+        let fp = File::open(file_path).map_err(|_| GeoIpReaderError::OpenFileError)?;
 
         let mut geoip_reader = GeoIpReader {
             fp,

diff --git a/src/lib.rs b/src/lib.rs
diff --git a/src/main.rs b/src/main.rs
diff --git a/src/time_zones.rs b/src/time_zones.rs
diff --git a/src/utils.rs b/src/utils.rs