MEGA SDK

The MEGA SDK provides multiple layers of access to MEGA's secure cloud storage:

1. Low-level SDK: Provides full access to all SDK features. The megacli command-line tool is the primary example of its usage.
2. Intermediate Layer: A documented layer designed to facilitate binding with other programming languages. The primary entry point is the include/megaapi.h header.
3. Example Applications: Provided for various platforms:
   • C++: A plain C++ example in examples/simple_client.
   • Android: Java bindings based on SWIG in examples/android.
   • iOS: Objective-C bindings in examples/iOS.

Additionally, MEGAcmd is a higher-level application that uses the SDK to provide interactive and scriptable access (e.g., via PHP or Python).

The iOS Example app is an Xcode project designed to demonstrate MEGA SDK capabilities on iOS (Target OS: iOS 7.0+). It provides a demo implementation for user authentication, file/folder management (listing, navigating, downloading, uploading, creating, deleting, renaming, exporting), and contact viewing.

Prerequisites

1. Download or clone the complete MEGA SDK repository.
2. Download the prebuilt third-party dependencies from this link.
3. Uncompress the dependencies and move the include and lib directories into sdk/bindings/ios/3rdparty.

Build Steps

1. Navigate to sdk/examples/iOS and open MEGA.xcworkspace in Xcode.
2. Ensure the Demo target is selected in the Xcode scheme selector.
3. Build and run the application on an iOS device or simulator.

The SDK uses CMake for configuration and VCPKG to manage dependencies on GNU/Linux, macOS, and Windows.

Prerequisites

Common Tools:

• Git
• CMake 3.19 or higher

Platform Specifics:

• Windows: Visual Studio 2022, MSVC v142, and Windows 10 SDK (10.0.22621.0).
• macOS: Xcode and Developer tools (xcode-select --install), plus autoconf, autoconf-archive, automake, pkg-config, nasm, and libtool.
• Linux (Debian-based): sudo apt install build-essential curl zip unzip autoconf autoconf-archive nasm libtool-bin

To prepare your workspace, create a directory, clone the SDK repository, and clone the VCPKG repository alongside it.

# Create workspace
mkdir mega
cd mega

# Clone SDK
git clone https://github.com/meganz/sdk

# Clone VCPKG (if not already present)
git clone https://github.com/microsoft/vcpkg

Note: Ensure your local VCPKG repository is up to date by running git pull inside the VCPKG directory to avoid dependency errors.

To create a new Release Candidate, configure the [make_another_rc] section in your local config.toml. The script automatically determines the new RC number by incrementing the last existing RC for that release by 1.

Required Environment Variables:

• GITLAB_TOKEN
• JIRA_TOKEN
• SLACK_TOKEN

Execution: Run the script from a directory within the repository intended for the RC.

python3 path/to/make_another_rc.py path/to/config.toml

The automation scripts require Python 3 (tested with 3.12.2).

Installation Steps:

1. Install pip (e.g., python3 -m ensurepip --upgrade or sudo apt install python3-pip on Ubuntu).
2. Install dependencies: pip install -r requirements.txt.
3. Handling externally-managed-environment errors: If you encounter this error, use a virtual environment:

   python3 -m venv .venv
   ./.venv/bin/python -m pip install -r requirements.txt

To enable Slack notifications, you must provide a User OAuth Token.

Setup Steps:

1. Create a Slack App via api.slack.com/apps.
2. In OAuth & Permissions, add the chat:write scope to User Token Scopes.
3. Install to Workspace and copy the User OAuth Token.
4. Set the token in the SLACK_TOKEN environment variable.

Channel and Thread Identification:

• Channel: Use the name (e.g., foo_bar without the #) or the ID from the web URL (the component after /client/AAAAAAAAA/).
• Thread ID: Obtain the thread ID from a message URL (e.g., .../archives/BBBBBBBBBBB/pTTTTTTTTTTTTTTTT). Split the TTTTTTTTTTTTTTTT part by a . to get the 10.6 format TTTTTTTT.TTTTTT.

To patch an existing release, configure the [patch_release] section in your local config.toml. Note that automation is only provided for step 7 and beyond due to complexity with multiple patches.

Required Environment Variables:

• GITLAB_TOKEN
• JIRA_TOKEN
• SLACK_TOKEN
• GPG_KEYGRIP
• GPG_PASSWORD

Execution: Run the script from a directory within the repository intended for patching.

python3 ./patch_release.py path/to/config.toml

Before building the third-party libraries and the MEGA SDK (libmega.so), you must configure the following environment variables or create symbolic links in your home directory:

• NDK_ROOT: Path to your Android NDK installation.
• ANDROID_HOME: Path to your Android SDK installation.
• JAVA_HOME: Path to your Java installation.

Symbolic Link Method: Alternatively, you can create symbolic links at ${HOME}/android-ndk, ${HOME}/android-sdk, and ${HOME}/android-java pointing to their respective installation paths.