Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mypdns/mk-cleaner

LIttle program that allows and admin to suspend users and delete their posts from a MissKey instance in one process
https://github.com/mypdns/mk-cleaner

ferris misskey misskey-api mypdns rust-lang

Last synced: about 2 months ago
JSON representation

LIttle program that allows and admin to suspend users and delete their posts from a MissKey instance in one process

Host: GitHub
URL: https://github.com/mypdns/mk-cleaner
Owner: mypdns
License: bsd-3-clause
Created: 2024-10-20T11:12:00.000Z (4 months ago)
Default Branch: master
Last Pushed: 2024-10-20T22:04:11.000Z (4 months ago)
Last Synced: 2024-10-22T13:41:40.585Z (4 months ago)
Topics: ferris, misskey, misskey-api, mypdns, rust-lang
Language: Rust
Homepage: https://www.mypdns.org
Size: 26.4 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Contributing: Contributing.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
- Support: .github/SUPPORT.md
- Governance: GOVERNANCE.md

Awesome Lists containing this project

README

        [![My Privacy DNS](https://www.mypdns.org/images/logo.png)](https://www.mypdns.org/)

[![ko-fi](https://www.mypdns.org/fileproxy/?name=sp_kofi_mypdns)]([DONATION.md](https://kb.mypdns.org/articles/MTX-A-3/DONATION))

[![liberapay](https://www.mypdns.org/fileproxy/?name=sp_receives_mypdns)](https://liberapay.com/MyPDNS/donate)

[![goal](https://www.mypdns.org/fileproxy/?name=sp_goal_mypdns)](https://liberapay.com/MyPDNS/donate)

# MK Cleaner

* [MK Cleaner](#mk-cleaner)

  * [Running MK Cleaner](#running-mk-cleaner)

  * [The error](#the-error)

  * [Other docs](#other-docs)

  * [History](#history)

Mk Cleaner is a little program that can operate with the API of a [Misskey][MK]

server. It should be able to do 3 things:

1. Suspend an Account based on internal(local) ID

2. Delete all the users posts

3. Delete all the users files

4. (If you are really bored) Cron the job to find these accounts by tags and do

   it by itself (Needs Some kind of manual approval system)

This is because I'm running and trying to maintain https://matrix.rocks/, and

this is part is sucking the life out of me, doing this manually.

The first commit to this project comes from : and is based on the Rust gradle

module [misskey-rs][MKRS], the gradle on [docs.rs][DRS], however, the project

kind a looks like it is no longer maintained, as last commit (as time of writing

this), was May 7, 2023

This may be the reason to the error I receive when running the code against the

server version `2024.10.0` while the last mention version on the project is

`v12.63.0`

## Running MK Cleaner

First, you should clone this repository to make it easy to update.

```shell

git clone https://github.com/mypdns/MK-Cleaner.git mk-ckleaner && \

    cd mk-ckleaner && cp mk-cleaner.sh.example mk-cleaner.sh

```

```shell

# This script will open your config file with your default editor, else help

# you set default editor (*nix ONLY)

if [ -n "$(which xdg-open)" ]; then

    xdg-open "mk-cleaner.sh"

elif [ -n "${VISUAL-${EDITOR-nano}}" ]; then

    ${VISUAL-${EDITOR-nano}} "mk-cleaner.sh"

elif [ -n "$(which editor)" ]; then

    editor "mk-cleaner.sh"

else

    echo "Your System suck!!!"

    echo "You should set a default editor for your system"

    echo "I'll help you this time!!!"

    select-editor || exit 1

    if [ -n "${VISUAL-${EDITOR-nano}}" ]; then

        ${VISUAL-${EDITOR-nano}} "mk-cleaner.sh"

    elif [ -n "$(which editor)" ]; then

        editor "mk-cleaner.sh"

    fi

fi

```

> [!NOTE]  

> This is subject to being altered once the program is fully

> functional, and released as stable.

> We, should change the way we read in the environment variables from a config

> file, and the rust program itself asks for the userID. 

> [!IMPORTANT]  

> Next you need to configure the `mk-cleaner.sh` by copying the

> `mk-cleaner.sh.example` to `mk-cleaner.sh` and set the values of

1. `MISSKEY_API_URL`, This is the full url to your API path, such as `https://example.org/api/`

2. `MISSKEY_TOKEN`, This is your private API_key from your installation URI, such as `https://example.org/settings/api`

Now you should be able to run `mk-cleaner.sh` like 

```shell

mk-cleaner.sh userID

```

## The error

The error seems to be related to how the json response is handled, and I don't

know if there is a workaround for this.

```rust

MISSKEY_API_URL="https://matrix.rocks/api/" MISSKEY_TOKEN="API_KEY" ./mk-cleaner $UID

Doing $UID

Failed to get user $UID notes: JSON error: invalid type: map, expected a sequence at line 1 column 825

users suspended: 1, not suspended: 0

notes deleted: 0, not deleted: 1

```

I've opened this issue https://github.com/coord-e/misskey-rs/issues/73

## Other docs

* Contributing: Contributing.md

* Code of Conduct: CODE_OF_CONDUCT.md

* License: BSD 3-Clause License

## History

This project started the 19th October 2024, 14:51 (CEST) with [this message] on

https://matrix.to/#/#rust-off-topic:xiretza.xyz

```json

{

  "content": {

    "body": "Hey, anyone of you who know how to code, that having a silent and even maybe a bored day?\n\nThen I would like to ask if one of you might like to give me a helping hand, by making a little program that can operate with the API of a Misskey server. It should be able to do 3 things\n\n1. Suspend an Account based on internal(local) ID\n2. Delete all the users posts \n3. Delete all the users files\n4. (If you are really bored) Cron the job to find these accounts by tags and do it by it self (Needs Some kind of manual approval system)\n\nThis is because I'm running and trying to maintain https://matrix.rocks/, and this is part is sucking the live out of me, doing this manually.",

    "format": "org.matrix.custom.html",

    "formatted_body": "
Hey, anyone of you who know how to code, that having a silent and even maybe a bored day?
\nThen I would like to ask if one of you might like to give me a helping hand, by making a little program that can operate with the API of a Misskey server. It should be able to do 3 things
\n\nSuspend an Account based on internal(local) ID
\nDelete all the users posts
\nDelete all the users files
\n(If you are really bored) Cron the job to find these accounts by tags and do it by it self (Needs Some kind of manual approval system)
\n
\nThis is because I'm running and trying to maintain https://matrix.rocks/, and this is part is sucking the live out of me, doing this manually.\n",

    "m.mentions": {},

    "msgtype": "m.text"

  },

  "origin_server_ts": 1729342275336,

  "sender": "@spirillen:matrix.org",

  "type": "m.room.message",

  "unsigned": {

    "membership": "join",

    "age": 79859907,

    "transaction_id": "m1729342274901.2"

  },

  "event_id": "$_codlYa9cAgjTh0W3xKuZ9oWbWDHRl-Z1IAJkWTPkH0",

  "room_id": "!yqjgpOiwXStfzObcpo:typ3.tech"

}

```

Some hours later [Kim Minh] replied with this code, you find in the [first commit]

[DRS]: https://docs.rs/misskey/latest/misskey/

[MK]: https://github.com/misskey-dev/misskey

[MKRS]: https://github.com/coord-e/misskey-rs

[RPG]: https://play.rust-lang.org/?version=stable&mode=debug&edition=2021&gist=3c63ed0325a458fbe12b654e3799ba87

[this message]: https://matrix.to/#/!yqjgpOiwXStfzObcpo:typ3.tech/$_codlYa9cAgjTh0W3xKuZ9oWbWDHRl-Z1IAJkWTPkH0?via=computer.surgery&via=matrix.org&via=mozilla.org

[Kim Minh]: https://matrix.to/#/@kaplan:matrix.org

[first commit]: https://github.com/mypdns/MK-Cleaner/commit/61c0af0d09cf87a51ca476abf6ceafb9a76e6012