📆 gcalsync: Sync Your Google Calendars Like a Boss! 🚀

Welcome to gcalsync, the ultimate tool for syncing your Google Calendars across multiple accounts! Say goodbye to calendar conflicts and hello to seamless synchronization. 🎉

🌟 Features

• 🔄 Sync events from multiple Google Calendars across different accounts
• 🚫 Create "blocker" events in other calendars to prevent double bookings
• 🗄️ Store access tokens and calendar data securely in a local SQLite database
• 🔒 Authenticate with Google using the OAuth2 flow for desktop apps
• 🧹 Easy way to cleanup calendars and remove all blocker events with a single command

📋 Prerequisites

• Go 1.16 or higher
• A Google Cloud Platform project with the Google Calendar API enabled
• OAuth2 credentials (client ID and client secret) for the desktop app flow

🚀 Getting Started

1. Clone the repository:

   git clone https://github.com/bobuk/gcalsync.git
   

2. Navigate to the project directory:

   cd gcalsync
   

3. Install the dependencies:

   go mod download
   

4. Create a .gcalsync.toml file in the project directory with your OAuth2 credentials:

   [general]
   disable_reminders = false              # Disable reminders for blocker events
   block_event_visibility = "private"     # Visibility of blocker events (private, public, or default)
   authorized_ports = [8080, 8081, 8082]  # Ports that can be used for OAuth callback
   
   [google]
   client_id = "your-client-id"           # Your OAuth2 client ID
   client_secret = "your-client-secret"   # Your OAuth2 client secret

   Don't forget to choose the appropriate OAuth2 consent screen settings and add the necessary scopes for the Google Calendar API, also double check that you are select "Desktop app" as application type.

   You can move the file to ~/.config/gcalsync/.gcalsync.toml to avoid storing sensitive data in the project directory. In this case your database file will be created in ~/.config/gcalsync/ as well.

5. Build the executable:

   go build
   

6. Run the gcalsync command with the desired action:

   • To add a new calendar:

     ./gcalsync add
     

   • To sync calendars:

     ./gcalsync sync
     

   • To desync calendars:

     ./gcalsync desync
     

   • To list all calendars:

     ./gcalsync list
     

📚 Documentation

🆕 Adding a Calendar

To add a new calendar to sync, run the gcalsync add command. You will be prompted to enter the account name and calendar ID. The program will guide you through the OAuth2 authentication process and store the access token securely in the local database.

🔄 Syncing Calendars

To sync your calendars, run the gcalsync sync command. The program will retrieve events from the specified calendars within the current and next month time window. It will create "blocker" events in other calendars to prevent double bookings and store the blocker event details in the local database.

🧹 Desyncing Calendars

To desync your calendars and remove all blocker events, run the gcalsync desync command. The program will retrieve the blocker event details from the local database and remove the corresponding events from the respective calendars.

📋 Listing Calendars

To list all calendars that have been added to the local database, run the gcalsync list command. The program will display the account name and calendar ID for each calendar.

🎗️ Disabling Reminders

By default blocker events will inherit your default Google Calendar reminder/alert settings (typically – 10 minutes before the event). If you do not want to receive reminders for the blocker events, you can disable them by setting the disable_reminders field to true in the .gcalsync.toml configuration file.

🕶️ Setting Block Event Visibility

By default blocker events will be created with the visibility set to "private". If you want to change the visibility of blocker events, you can set the block_event_visibility field to "public" or "default" in the .gcalsync.toml configuration file.

Configuration File

The .gcalsync.toml configuration file is used to store OAuth2 credentials and general settings for the program. You can customize the settings to suit your preferences and needs. The file should be located in the project directory or ~/.config/gcalsync/ directory.

At a minimum, the configuration file should contain the following fields:

[google]
client_id = "your-client-id"
client_secret = "your-client-secret"

Additional sections and fields can be added to configure the program behavior:

[general]
block_event_visibility = "private"    # Keep O_o event public or private
disable_reminders = true              # Set reminders on O_o events or not
verbosity_level = 1                   # How much chatter to spill out when running sync
authorized_ports = [3000, 3001, 3002] # Casllback ports to listen to for OAuth token response

🔌 Configuration Parameters

• [google] section
  • client_id: Your Google app client ID
  • client_secret Your Google app configuration secret
• [general] section
  • authorized_ports: The application needs to start a temporary local server to receive the OAuth callback from Google. By default, it will try ports 8080, 8081, and 8082. You can customize these ports by setting the authorized_ports array in your configuration file. The application will try each port in order until it finds an available one. Make sure these ports are allowed by your firewall and not in use by other applications.
  • block_event_visibility: Defines whether you want to keep blocker events ("O_o") publicly visible or not. Posible values are private or public. If ommitted -- public is used.
  • disable_reminders: Whether your blocker events should stay quite and not alert you. Possible values are true or false. default is false.
  • verbosity_level: How "chatty" you want the app to be 1..3 with 1 being mostly quite and 3 giving you full details of what it is doing.

🤝 Contributing

Contributions are welcome! If you encounter any issues or have suggestions for improvement, please open an issue or submit a pull request. Let's make gcalsync even better together! 💪

📄 License

This project is licensed under the MIT License. Feel free to use, modify, and distribute the code as you see fit. We hope you find it useful! 🌟

🙏 Acknowledgements

• The terrible Go programming language
• The Google Calendar API for making this project almost impossible to implement
• The OAuth2 protocol for very missleading but secure authentication
• The SQLite database for lightweight and efficient storage, the only one that added no pain.