pyrekordbox 0.2.3__py3-none-any.whl → 0.3.0__py3-none-any.whl

docs/source/index.md

@@ -11,7 +11,6 @@ sphinx-quickstart on Thu Apr  7 15:06:50 2022.
 [![Python][python-badge+]][pypi-link]
 [![Platform][platform-badge]][pypi-link]
 [![license: MIT][license-badge]][license-link]
-[![style: black][black-badge]][black-link]
 
 ```{admonition} Disclaimer
 This project is not affiliated with Pioneer Corp. or its related companies
@@ -45,6 +44,7 @@ caption: User Guide
 
 quickstart
 installation
+key
 tutorial/index
 api
 ```
@@ -94,12 +94,10 @@ PyPI <https://pypi.org/project/pyrekordbox/>
 [platform-badge]: https://img.shields.io/badge/platform-win%20%7C%20osx-blue?style=flat
 [pypi-badge]: https://img.shields.io/pypi/v/pyrekordbox?style=flat
 [license-badge]: https://img.shields.io/pypi/l/pyrekordbox?color=lightgrey
-[black-badge]: https://img.shields.io/badge/code%20style-black-000000?style=flat
 
 [pypi-link]: https://pypi.org/project/pyrekordbox/
 [license-link]: https://github.com/dylanljones/pyrekordbox/blob/master/LICENSE
 [tests-link]: https://github.com/dylanljones/pyrekordbox/actions/workflows/tests.yml
-[black-link]: https://github.com/psf/black
 [codecov-link]: https://app.codecov.io/gh/dylanljones/pyrekordbox/tree/master
 
 [issue]: https://github.com/dylanljones/pyrekordbox/issues/64

docs/source/installation.md

@@ -20,7 +20,7 @@ $ pip install .
 ```
 
 
-## Dependencies
+## Installing SQLCipher
 
 Unlocking the new Rekordbox 6 `master.db` database file requires [SQLCipher][sqlcipher].
 Pyrekordbox makes no attempt to download/install SQLCipher, as it is a
@@ -261,12 +261,6 @@ c.execute("PRAGMA key='password'")
 ````
 
 
-## References:
-
-- [https://stackoverflow.com/questions/33618565/how-to-build-sql-cipher-python-binding-for-windows](https://stackoverflow.com/questions/33618565/how-to-build-sql-cipher-python-binding-for-windows)
-- [https://github.com/Monogi/pysqlcipher3_install_win10](https://github.com/Monogi/pysqlcipher3_install_win10)
-
-
 
 [VS]: https://visualstudio.microsoft.com/de/vs/community/
 [OpenSSL]: https://slproweb.com/products/Win32OpenSSL.html

docs/source/key.md

@@ -0,0 +1,104 @@
+# Database key
+
+If you are using Rekordbox v6.6.5 or later and have no cached key from a previous
+Rekordbox version, the database can not be unlocked automatically.
+However, the command line interface of ``pyrekordbox`` provides a command for downloading
+the key from known sources and writing it to the cache file:
+````shell
+python -m pyrekordbox download-key
+````
+Once the key is cached the database can be opened without providing the key.
+if you obtained the key from another source, you can also pass it to the database handler
+````python
+db = Rekordbox6Database(key="<insert key here>")
+````
+or write it to the cache file manually:
+````python
+from pyrekordbox.config import write_db6_key_cache
+
+write_db6_key_cache("<insert key here>")  # call once
+db = Rekordbox6Database()
+````
+
+## Alternative methods
+
+The key can be extracted manually from the users machine. After the key is obtained
+it can be writen to the cache file as described above.
+The method varies depending on the operating system.
+
+### Windows
+
+On Windows, the key can be extracted from the Rekordbox executable using a debugger:
+
+1. Download [x64dbg] and run it.
+
+2. Options -> Preferences. Make sure "Entry Breakpoint" is set in the Events tab.
+
+3. File -> Open... `rekordbox.exe` (the main application executable)
+
+4. Look at the status bar. It should have a yellow "Paused" icon followed by some status text.
+   Right now it should say "System breakpoint reached!"
+
+5. Hit F9 or press the Run button in the top bar. The status text should change to
+   "INT3 breakpoint 'entry breakpoint' at <rekordbox.EntryPoint>".
+
+6. Click in the disassembly window, then press Ctrl+G to open the Go To Expression box,
+   and search for `sqlite3_key_v2` and press OK. This should jump you to the code for
+   that function, which typically starts with `mov dword ptr ss:[rsp+xx], r9d` or similar.
+
+7. Without clicking anywhere on the disassembly window, press F2 to toggle breakpoint.
+   The top instruction's address should turn red.
+
+8. Hit F9 or press the Run button in the top bar. The status text will start changing
+   a bunch, while the program starts up. Wait until the status bar goes back to "Paused"
+   in yellow. If the status text says something like "First chance exception on..."
+   press F9 again.
+
+9. The status bar should go to "Paused" in yellow again, this time with status text
+   that says "INT3 breakpoint at <sqlite3.sqlite3_key_v2>". This means our breakpoint
+   has been hit.
+
+10. Click the register panel (top right, where RAX, RBX, RCX, etc. are listed) so
+   it updates. Right click the red address next to R8, and click "Follow in dump".
+
+11. The dump at the bottom left will move to that address. Right click the dump panel
+   and select Text -> ASCII at the bottom. You should now see the key as a string.
+   You can drag-select it, then right click to copy selected line.
+
+12. Go to Debug -> Close to close the process, then close x64dbg.
+
+
+```{figure} /_static/images/x64dbg_rb_key.png
+:align: center
+:scale: 60
+```
+
+
+### MacOS
+
+On MacOS, the key can be extracted using the [RekordLocksmith] tool:
+
+1. Install LLDB:
+   - LLDB can be installed with Xcode on macOS via the App Store or xcode-cli-commands.
+   - Ensure LLDB is accessible from the terminal by running `lldb` in the terminal.
+
+2. Disable SIP:
+   - Restart your Mac and hold down `Command-R` as it boots to enter Recovery Mode.
+   - Open the Terminal from the Utilities menu.
+   - Type `csrutil disable` and press Enter.
+   - Restart your Mac.
+
+3. Download RekordLocksmith:
+   - Clone or download the [RekordLocksmith] repository from GitHub.
+
+4. Run RekordLocksmith:
+   - Use the terminal to navigate to the folder containing `rekordlocksmith.py`.
+   - Run the script:
+     ````shell
+     python3 rekordlocksmith.py /Applications/rekordbox\ 6/rekordbox.app/Contents/MacOS/rekordbox
+     ````
+     The tool will output the database key to the terminal and save it to a file named `rekordbox_db_pass.txt` in the current directory.
+
+
+[x64dbg]: https://x64dbg.com/
+[RekordLocksmith]: https://github.com/Bide-UK/rekordlocksmith#rekordlocksmith

docs/source/quickstart.md

@@ -101,7 +101,7 @@ between two databases.
 Pyrekordbox can read and write Rekordbox XML databases.
 
 ````python
-from pyrekordbox.xml import RekordboxXml
+from pyrekordbox.rbxml import RekordboxXml
 
 xml = RekordboxXml("database.xml")
 

pyrekordbox/__init__.py

@@ -4,7 +4,7 @@
 
 from .logger import logger
 from .config import show_config, get_config, update_config
-from .xml import RekordboxXml, XmlDuplicateError, XmlAttributeKeyError
+from .rbxml import RekordboxXml, XmlDuplicateError, XmlAttributeKeyError
 from .anlz import get_anlz_paths, walk_anlz_paths, read_anlz_files, AnlzFile
 from .mysettings import (
     get_mysetting_paths,

pyrekordbox/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.2.3'
-__version_tuple__ = version_tuple = (0, 2, 3)
+__version__ = version = '0.3.0'
+__version_tuple__ = version_tuple = (0, 3, 0)

pyrekordbox/anlz/file.py

@@ -114,10 +114,10 @@ class AnlzFile(abc.Mapping):
                 # Check if the file is garbled (only on exported files)
                 # For this we check the validity of mood and bank
                 # Mood: High=1, Mid=2, Low=3
-                # Bank: 1-8
+                # Bank: 0-8
                 mood = Int16ub.parse(tag_data[18:20])
                 bank = Int16ub.parse(tag_data[28:30])
-                if 1 <= mood <= 3 and 1 <= bank <= 8:
+                if 1 <= mood <= 3 and 0 <= bank <= 8:
                     logger.debug("PSSI is not garbled!")
                 else:
                     logger.debug("PSSI is garbled!")

pyrekordbox/db6/database.py

@@ -222,6 +222,11 @@ class Rekordbox6Database:
                         "Please use the CLI of pyrekordbox to download the key or "
                         "use the `key` parameter to manually provide it."
                     )
+            else:
+                # Check if key looks like a valid key
+                if not key.startswith("402fd"):
+                    raise ValueError("The provided database key doesn't look valid!")
+
             logger.info("Key: %s", key)
             # Unlock database and create engine
             url = f"sqlite+pysqlcipher://:{key}@/{path}?"
@@ -1822,7 +1827,9 @@ class Rekordbox6Database:
         root = self.get_anlz_dir(content)
         return read_anlz_files(root)
 
-    def update_content_path(self, content, path, save=True, check_path=True):
+    def update_content_path(
+        self, content, path, save=True, check_path=True, commit=True
+    ):
         """Update the file path of a track in the Rekordbox v6 database.
 
         This changes the `FolderPath` entry in the ``DjmdContent`` table and the
@@ -1839,6 +1846,8 @@ class Rekordbox6Database:
             If True, the changes made are written to disc.
         check_path : bool, optional
             If True, raise an assertion error if the given file path does not exist.
+        commit : bool, optional
+            If True, the changes are committed to the database. True by default.
 
         Examples
         --------
@@ -1855,7 +1864,7 @@ class Rekordbox6Database:
         Updating the path changes the database entry
 
         >>> new_path = "C:/Music/PioneerDJ/Sampler/PRESET ONESHOT/NOISE.wav"
-        >>> db.update_content_path(cont, new_path)
+        >>> db.update_content_path(cont, path)
         >>> cont.FolderPath
         C:/Music/PioneerDJ/Sampler/PRESET ONESHOT/NOISE.wav
 
@@ -1889,15 +1898,31 @@ class Rekordbox6Database:
         logger.debug("Updating database file path: %s", path)
         content.FolderPath = path
 
+        # Update the OrgFolderPath column with the new path
+        # if the column matches the old_path variable
+        org_folder_path = content.OrgFolderPath
+        if org_folder_path == old_path:
+            content.OrgFolderPath = path
+
+        # Update the FileNameL column with the new filename if it changed
+        new_name = path.split("/")[-1]
+        if content.FileNameL != new_name:
+            content.FileNameL = new_name
+
         if save:
-            logger.debug("Saving changes")
+            logger.debug("Saving ANLZ files")
             # Save ANLZ files
             for anlz_path, anlz in anlz_files.items():
                 anlz.save(anlz_path)
+
+        if commit:
             # Commit database changes
+            logger.debug("Committing changes to the database")
             self.commit()
 
-    def update_content_filename(self, content, name, save=True, check_path=True):
+    def update_content_filename(
+        self, content, name, save=True, check_path=True, commit=True
+    ):
         """Update the file name of a track in the Rekordbox v6 database.
 
         This changes the `FolderPath` entry in the ``DjmdContent`` table and the
@@ -1914,6 +1939,8 @@ class Rekordbox6Database:
             If True, the changes made are written to disc.
         check_path : bool, optional
             If True, raise an assertion error if the new file path does not exist.
+        commit : bool, optional
+            If True, the changes are committed to the database. True by default.
 
         See Also
         --------
@@ -1939,7 +1966,6 @@ class Rekordbox6Database:
         >>> file = list(files.values())[0]
         >>> cont.FolderPath == file.get("path")
         True
-
         """
         if isinstance(content, (int, str)):
             content = self.get_content(ID=content)
@@ -1948,7 +1974,7 @@ class Rekordbox6Database:
         ext = old_path.suffix
         new_path = old_path.parent / name
         new_path = new_path.with_suffix(ext)
-        self.update_content_path(content, new_path, save, check_path)
+        self.update_content_path(content, new_path, save, check_path, commit=commit)
 
     def to_dict(self, verbose=False):
         """Convert the database to a dictionary.