Remove modmail telemetry and update PRIVACY.md

Author: khakers

PRIVACY.md

@@ -1,11 +1,17 @@
 # Privacy Statement
 
-Hey, we are the lead developers of Modmail bot. This is a look into the data we collect, the data you collect, the data other parties collect, and what can be done about any of this data.    
+Hey, we are the lead developers of Modmail bot. This is a look into the data you collect, the data other parties collect, and what can be done about any of this data.    
 > **Disclaimer**: None of us are lawyers. We are just trying to be more transparent
 
+OpenModmail is a fork of Modmail, and this privacy policy is a fork of the original Modmail privacy policy.
+All telemetry and data collection has been removed from OpenModmail.
+
+> [!NOTE]
+> Plugins may collect additional data. Please check with the plugin developer for more information.
+
 ### TL;DR
 
-Yes, we collect some data to keep us happy. You collect some data to keep the bot functioning. External services also collect some data that is out of our control.
+You collect some data to keep the bot functioning. External services also collect some data that is out of our control.
 
 ## Interpretation
 
@@ -18,38 +24,6 @@ Yes, we collect some data to keep us happy. You collect some data to keep the bo
 - Database: A location where data is stored, hosted by the bot owner. The following types of database are currently supported: [MongoDB](#MongoDB).
 - Logviewer: A webserver hosted by the bot owner.
 
-## The Data We Collect
-
-No data is being collected unless someone decides to host the bot and the bot is kept online.
-
-The Modmail Team collect some metadata to keep us updated on the number of instances that are making use of the bot and know what features we should focus on. The following is a list of data that we collect:
-- Bot ID
-- Bot username and discriminator
-- Bot avatar URL
-- Main guild ID
-- Main guild name
-- Main guild member count
-- Bot uptime
-- Bot latency
-- Bot version
-- Whether the bot is selfhosted
-
-No tokens/passwords/private data is ever being collected or sent to our servers.
-
-This metadata is sent to our centralised servers every hour that the bot is up and can be viewed in the bot logs when the `log_level` is set to `DEBUG`.
-
-As our bot is completely open-source, the part that details this behaviour is located in `bot.py > ModmailBot > post_metadata`.
-
-We assure you that the data is not being sold to anybody.
-
-### Opting out
-
-The bot owner can opt out of this data collection by setting `data_collection` to `off` within the configuration variables or the `.env` file.
-
-### Data deletion
-
-Data can be deleted with a request in a DM to our [support server](https://discord.gg/etJNHCQ)'s Modmail bot.
-
 ## The Data You Collect
 
 When using the bot, the bot can collect various bits of user data to ensure that the bot can run smoothly.    
@@ -74,7 +48,7 @@ When a message is sent in a thread, the bot saves the following data:
 - Message author avatar URL
 - Whether the message author is a moderator
 - Message content
-- All attachment urls in the message
+- Attachments
 
 This data is essential to have live logs for the web logviewer to function.    
 The Modmail team does not track any data by users.
@@ -99,11 +73,6 @@ If you wish to opt out of any of this data collection, please view their own pri
 
 - [Discord Privacy Policy](https://discord.com/privacy)
 
-### Heroku
-
-- [Heroku Security](https://www.heroku.com/policy/security)
-- [Salesforce Privacy Policy](https://www.salesforce.com/company/privacy/).
-
 ### MongoDB
 
 - [MongoDB Privacy Policy](https://www.mongodb.com/legal/privacy-policy).

README.md

@@ -21,6 +21,20 @@
 <img src='https://github.com/raidensakura/modmail/assets/38610216/106e8fa3-6f8e-4b00-9968-f5c2f3108da0' align='center' width=500>
 </div>
 
+> [!NOTE]
+> This is a maintained *hard* fork of modmail by khakers based on [raidensakura](https://github.com/raidensakura)'s fork
+> of modmail.
+> This fork is not affiliated with the original modmail project.
+> It was done to add features that were not being added to the original modmail project due to its inactivity and to
+> better align with what I wanted for modmail-viewer
+
+I am the developer of [modmail-viewer](https://github.com/khakers/modmail-viewer), which is the recommended way to view
+logs for this fork.
+Although you can use the built-in logviewer plugin, it is not recommended as it is not as feature-rich as
+modmail-viewer, and I do not intend to maintain it.
+The logviewer plugin is included with this fork, but it is disabled by default, and it contains extras features and
+security fixes that are not present in the original logviewer plugin.
+
 ## Features
 
 * **Highly Customisable:**
@@ -45,7 +59,6 @@
   * Support for the diverse range of message contents (multiple images, files).
   * Paginated commands interfaces via reactions.
 
-This list is ever-growing thanks to active development and our exceptional contributors. See a full list of documented commands by using the `?help` command.
 
 ## Installation
 
@@ -58,7 +71,7 @@ This guide assumes you have git, and a supported Python version installed and ad
 
 1. Clone the repository
     ```console
-    $ git clone https://github.com/raidensakura/modmail
+    $ git clone https://github.com/khakers/openmodmail
     $ cd modmail
     ```
 2. Create a Discord bot account, grant the necessary intents, and invite the bot.
@@ -113,9 +126,9 @@ Issues with the bot can be opened through [GitHub Issues](https://github.com/kha
 
 ## Contributing
 
-Check out the [contributing guidelines](https://github.com/raidensakura/modmail/blob/stable/.github/CONTRIBUTING.md) before you get started.
+Check out the [contributing guidelines](https://github.com/khakers/modmail/blob/stable/.github/CONTRIBUTING.md) before you get started.
 
-The [develop](https://github.com/raidensakura/modmail/tree/develop) branch is where most of the features are tested before stable release.
+The [develop](https://github.com/khakers/openmodmail/tree/develop) branch is where most of the features are tested before stable release.
 
 This project has included pre-commit script that automatically runs black and ruff linter on every commit.
 

bot.py

@@ -651,7 +651,6 @@ async def on_ready(self):
             )
             logger.warning("If the external servers are valid, you may ignore this message.")
 
-        self.post_metadata.start()
         self.autoupdate.start()
         self._started = True
 
@@ -1579,49 +1578,6 @@ async def on_command_error(
         else:
             logger.error("Unexpected exception:", exc_info=exception)
 
-    @tasks.loop(hours=1)
-    async def post_metadata(self):
-        info = await self.application_info()
-
-        delta = discord.utils.utcnow() - self.start_time
-        data = {
-            "bot_id": self.user.id,
-            "bot_name": str(self.user),
-            "avatar_url": self.user.display_avatar.url,
-            "guild_id": self.guild_id,
-            "guild_name": self.guild.name,
-            "member_count": len(self.guild.members),
-            "uptime": delta.total_seconds(),
-            "latency": f"{self.ws.latency * 1000:.4f}",
-            "version": str(self.version),
-            "selfhosted": True,
-            "last_updated": str(discord.utils.utcnow()),
-        }
-
-        if info.team is not None:
-            data.update(
-                {
-                    "owner_name": info.team.owner.name if info.team.owner is not None else "No Owner",
-                    "owner_id": info.team.owner_id,
-                    "team": True,
-                }
-            )
-        else:
-            data.update({"owner_name": info.owner.name, "owner_id": info.owner.id, "team": False})
-
-        async with self.session.post("https://api.modmail.dev/metadata", json=data):
-            logger.debug("Uploading metadata to Modmail server.")
-
-    @post_metadata.before_loop
-    async def before_post_metadata(self):
-        await self.wait_for_connected()
-        if not self.config.get("data_collection") or not self.guild:
-            self.post_metadata.cancel()
-            return
-
-        logger.debug("Starting metadata loop.")
-        logger.line("debug")
-
     @tasks.loop(hours=1)
     async def autoupdate(self):
         changelog = await Changelog.from_url(self)