Compare commits

..

1 Commits

158 changed files with 1599 additions and 12713 deletions
-37
View File
@@ -1,37 +0,0 @@
---
name: Bug report
about: Report a bug
title: ''
labels: bug
assignees: ''
---
## Description
A clear and concise description of what the bug is.
## Environment
Please provide as much of the following information as is relevant.
Host OS (macOS/Linux/WSL):
Host OS version:
<!-- macOS: Apple Logo > About this Mac -->
<!-- Linux: -->
<!-- cat /etc/*-release -->
<!-- Windows: -->
<!-- Get-WinVer; wsl -l -v -->
iOS device version:
<!-- Settings > General > About > iOS Version -->
Swift version:
<!-- swift --version -->
SDK version:
<!-- macOS: -->
<!-- xcodebuild -version; xcrun -sdk iphoneos -show-sdk-version -->
<!-- Linux/WSL: -->
<!-- swift sdk configure darwin arm64-apple-ios --show-configuration | grep -o 'iPhoneOS[0-9.]*\.sdk$' -->
-10
View File
@@ -1,10 +0,0 @@
---
name: Feature request
about: Suggest an idea
title: ''
labels: enhancement
assignees: ''
---
@@ -1,9 +0,0 @@
name: 'Configure Xcode'
description: 'Set up Xcode version'
runs:
using: composite
steps:
- name: Set up Xcode
shell: bash
run: |
sudo xcode-select -s /Applications/Xcode_26.4.app
+7 -31
View File
@@ -1,11 +1,5 @@
on:
push:
branches:
- main
pull_request:
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
- push
jobs:
build-linux:
strategy:
@@ -19,33 +13,15 @@ jobs:
runs-on: ${{ matrix.host.runner }}
steps:
- name: Checkout
uses: actions/checkout@v6
- name: Build and test
uses: actions/checkout@v4
- name: Build
run: |
docker compose run --build xtool bash -c \
"swift build --product xtool && .build/debug/xtool --help && swift test"
docker compose run --build --rm xtool -c "swift build --product xtool"
build-macos:
runs-on: macos-26
runs-on: macos-15
steps:
- name: Checkout
uses: actions/checkout@v6
- uses: ./.github/actions/configure-xcode
uses: actions/checkout@v4
- name: Build
run: |
swift build --product xtool && .build/debug/xtool --help
- name: Run tests
run: |
swift test
build-ios:
runs-on: macos-26
steps:
- name: Checkout
uses: actions/checkout@v6
- uses: ./.github/actions/configure-xcode
- name: Build
run: |
set -o pipefail \
&& xcodebuild build \
-skipMacroValidation -skipPackagePluginValidation \
-scheme XKit -destination generic/platform=iOS \
| xcbeautify
swift build --product xtool
+49
View File
@@ -0,0 +1,49 @@
on:
workflow_dispatch:
jobs:
build:
strategy:
fail-fast: false
matrix:
host:
- runner: ubuntu-24.04
arch: x86_64
- runner: ubuntu-24.04-arm
arch: aarch64
runs-on: ${{ matrix.host.runner }}
permissions:
contents: write
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Build
run: |
docker compose run --build --rm xtool -c "Linux/build.sh && mv Linux/packages/xtool{,-${{ matrix.host.arch }}}.AppImage"
- name: Upload artifact
id: upload_artifact
uses: actions/upload-artifact@v4
with:
name: xtool-${{ matrix.host.arch }}
path: Linux/packages/xtool-${{ matrix.host.arch }}.AppImage
release:
needs: build
runs-on: ubuntu-24.04
permissions:
contents: write
env:
GH_TOKEN: ${{ github.token }}
steps:
- uses: actions/checkout@v4
- name: Download artifact
id: download_artifact
uses: actions/download-artifact@v4
with:
pattern: xtool-*
path: output
- name: Create and publish release
id: publish_release
run: |
TAG="${GITHUB_REF##*/}-${GITHUB_SHA:0:7}"
gh release create "$TAG" --draft --title "Draft Release"
gh release upload "$TAG" output/**/*.AppImage
-83
View File
@@ -1,83 +0,0 @@
on:
push:
tags:
- "*"
jobs:
build-linux:
strategy:
fail-fast: false
matrix:
host:
- runner: ubuntu-24.04
arch: x86_64
- runner: ubuntu-24.04-arm
arch: aarch64
runs-on: ${{ matrix.host.runner }}
permissions:
contents: write
steps:
- name: Checkout
uses: actions/checkout@v6
- name: Build
run: |
docker compose run --build \
-e XTOOL_VERSION=${{ github.ref_name }} \
--rm xtool Linux/build.sh
- name: Upload artifact
uses: actions/upload-artifact@v7
with:
name: xtool-${{ matrix.host.arch }}
path: |
Linux/packages/xtool-${{ matrix.host.arch }}.AppImage
Linux/packages/xtool-${{ matrix.host.arch }}.AppImage.zsync
build-mac:
runs-on: macos-26
permissions:
contents: write
steps:
- name: Checkout
uses: actions/checkout@v6
- uses: ./.github/actions/configure-xcode
- name: Setup Ruby
uses: ruby/setup-ruby@v1
with:
working-directory: macOS
bundler-cache: true
- name: Build
env:
APP_STORE_CONNECT_API_KEY_KEY_ID: ${{ secrets.APP_STORE_CONNECT_API_KEY_KEY_ID }}
APP_STORE_CONNECT_API_KEY_ISSUER_ID: ${{ secrets.APP_STORE_CONNECT_API_KEY_ISSUER_ID }}
APP_STORE_CONNECT_API_KEY_KEY: ${{ secrets.APP_STORE_CONNECT_API_KEY_KEY }}
IDENTITY_P12: ${{ secrets.IDENTITY_P12 }}
DEVELOPMENT_TEAM: ${{ secrets.DEVELOPMENT_TEAM }}
XTOOL_VERSION: ${{ github.ref_name }}
run: |
cd macOS
bundle exec fastlane package
- name: Upload artifacts
uses: actions/upload-artifact@v7
with:
name: xtool-mac
path: |
macOS/Build/Output/xtool.app.zip
macOS/Build/Output/xtool.app.dSYM.zip
release:
needs: [build-linux, build-mac]
runs-on: ubuntu-24.04
permissions:
contents: write
env:
GH_TOKEN: ${{ github.token }}
steps:
- uses: actions/checkout@v6
- name: Download artifact
uses: actions/download-artifact@v8
with:
pattern: xtool-*
path: output
- name: Create and publish release
run: |
TAG="${{ github.ref_name }}"
gh release create "$TAG" --draft --title "v$TAG"
gh release upload "$TAG" output/**/*.{AppImage,AppImage.zsync,app.zip,app.dSYM.zip}
-19
View File
@@ -1,19 +0,0 @@
on:
push:
branches:
- main
pull_request:
paths:
- '.github/workflows/swiftlint.yml'
- '.swiftlint.yml'
- '**/*.swift'
jobs:
swiftlint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- name: Lint
run: |
make lint SWIFTLINT_FLAGS='--reporter=github-actions-logging' | tee swiftlint.log
# fail if there are any errors or warnings
! grep -Eq '^::(error|warning)' swiftlint.log
-1
View File
@@ -12,4 +12,3 @@ DerivedData/
.docc-build
/openapi
/.tmp
+14
View File
@@ -0,0 +1,14 @@
version: 1
builder:
configs:
- scheme: xtool
platform: macosSpm
documentation_targets:
- xtool
- scheme: xtool
platform: macosXcodebuild
# - scheme: xtool
# platform: linux
# image: # TODO: we need to use our own Docker image for this
- scheme: XKit
platform: ios
-73
View File
@@ -1,73 +0,0 @@
swiftlint_version: 0.59.1
disabled_rules:
- trailing_comma
- nesting
- fallthrough
- shorthand_operator
- todo
- large_tuple
- identifier_name
- type_name
- unneeded_override
- optional_data_string_conversion
- for_where
- blanket_disable_command
opt_in_rules:
- closure_end_indentation
- closure_spacing
- empty_count
- explicit_init
- fatal_error_message
- first_where
- implicit_return
- joined_default_parameter
- literal_expression_end_indentation
- overridden_super_call
- prohibited_super_call
- sorted_first_last
- unneeded_parentheses_in_closure_argument
- vertical_parameter_alignment_on_call
- yoda_condition
- nslocalizedstring_key
- unused_setter_value
- optional_enum_case_matching
- prefer_self_type_over_type_of_self
- contains_over_range_nil_comparison
- flatmap_over_map_reduce
- empty_collection_literal
- contains_over_first_not_nil
- contains_over_filter_count
- contains_over_filter_is_empty
- reduce_into
analyzer_rules:
- unused_import
custom_rules:
spaces_not_tabs:
name: "Spaces not Tabs"
regex: ^\t
message: "Use four spaces, not tabs"
point_zero:
name: "Point Zero"
regex: '(?<!iOS\s)(?<!macOS\s)(?<!\.)\b[\d_]+\.0\b'
match_kinds:
- number
- attribute.builtin
message: "Don't add a .0 to the end of floating point literals"
force_try: warning
force_cast: warning
function_body_length: 100
line_length: 135
file_length: 1000
type_body_length: 500
cyclomatic_complexity: 12
function_parameter_count: 7
implicit_return:
included:
- closure
included:
- Package.swift
- Sources
- Tests
- macOS/XToolMac
excluded:
- Sources/DeveloperAPI/Generated
-1
View File
@@ -1 +0,0 @@
/launch.json
-6
View File
@@ -1,6 +0,0 @@
{
"recommendations": [
"swiftlang.swift-vscode",
"vknabel.vscode-swiftlint",
]
}
-13
View File
@@ -1,13 +0,0 @@
{
"swiftlint.path": "./.tmp/swiftlint/swiftlint",
"files.watcherExclude":{
"*/.git/**": true,
"*/.build/**": true,
"*/.tmp/**": true,
},
"search.exclude": {
"*/.git/**": true,
"*/.build/**": true,
"*/.tmp/**": true,
}
}
-128
View File
@@ -1,128 +0,0 @@
# Contributor Covenant Code of Conduct
## Our Pledge
We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, religion, or sexual identity
and orientation.
We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.
## Our Standards
Examples of behavior that contributes to a positive environment for our
community include:
* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the
overall community
Examples of unacceptable behavior include:
* The use of sexualized language or imagery, and sexual attention or
advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email
address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
## Enforcement Responsibilities
Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.
Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.
## Scope
This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
conduct@xtool.sh.
All complaints will be reviewed and investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the
reporter of any incident.
## Enforcement Guidelines
Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:
### 1. Correction
**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.
**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.
### 2. Warning
**Community Impact**: A violation through a single incident or series
of actions.
**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or
permanent ban.
### 3. Temporary Ban
**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.
**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.
### 4. Permanent Ban
**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.
**Consequence**: A permanent ban from any sort of public interaction within
the community.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).
[homepage]: https://www.contributor-covenant.org
For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.
-31
View File
@@ -1,31 +0,0 @@
# Contributing to xtool
## Bug reports and feature requests
We welcome all bug reports and feature requests! Please create a [new issue](https://github.com/xtool-org/xtool/issues/new/choose) via GitHub.
## Documentation
The xtool documentation at <https://xtool.sh> is built with [swift-docc](https://github.com/swiftlang/swift-docc) and resides at [Documentation/xtool.docc](/Documentation/xtool.docc). It's hosted on Netlify, the configuration for which is in [netlify.toml](/netlify.toml).
When editing the DocC bundle, you can preview it with `make docs-preview`.
Once you make a pull request with your changes, we'll also generate a [Netlify Deploy Preview](https://docs.netlify.com/site-deploys/deploy-previews/) under your pull request. You can open this preview to see how the changes will look in production.
## Code
When making code changes, please make sure to test them on both macOS and Linux if possible. If you can also test on Windows with WSL, that is ideal.
To build xtool for debugging, run `make` in the project directory. There are a few considerations depending on your host OS:
### macOS
On macOS, you'll firstly need to have Xcode set up.
The first time you run `make`, we'll try to detect your codesigning identity. If you have multiple, you'll see an interactive prompt to select the team you want to use. The team ID is saved to `./macOS/Support/Private-Team.xcconfig`. You can run `make team` to update it (or do so by hand).
After building, a symlink to the product will be created at `./macOS/Build/xtool`. We generate an Xcode project at `./macOS/XToolMac.xcodeproj` that you can open in order to work in Xcode.
### Linux
You need to have a few dependencies on Linux; see [Dockerfile](/Dockerfile) for specifics. It's often easiest to develop within Docker itself: see [Linux/README.md](/Linux/README.md) for details.
+3 -3
View File
@@ -1,7 +1,7 @@
# Note: We use 22.04 since AppImage recommends building on the
# Note: We use 20.04 since AppImage recommends building on the
# oldest configuration that you support
FROM swift:6.3-jammy AS build-base
FROM swift:6.1-focal AS build-base
RUN apt-get update \
&& DEBIAN_FRONTEND=noninteractive apt-get install -y --no-install-recommends \
@@ -94,4 +94,4 @@ ENV USBMUXD_SOCKET_ADDRESS=host.docker.internal:27015
WORKDIR /xtool
CMD [ "/bin/bash" ]
ENTRYPOINT [ "/bin/bash" ]
-25
View File
@@ -1,25 +0,0 @@
#!/bin/bash
set -euo pipefail
cd "$(dirname "$0")"
rm -rf docs
if type -p xcrun &>/dev/null; then
docc="$(xcrun -f docc)"
else
docc="docc"
fi
if [[ $# == 0 ]]; then
command="convert"
elif [[ $# == 1 && ( "$1" == "preview" || "$1" == "convert" ) ]]; then
command="$1"
else
echo "Usage: $0 [convert|preview]"
exit 1
fi
"$docc" "$command" xtool.docc \
--experimental-enable-custom-templates
-143
View File
@@ -1,143 +0,0 @@
# Create App Extensions
Add app extensions to your iOS app.
## Overview
iOS includes several [App Extension Points](https://developer.apple.com/documentation/technologyoverviews/app-extensions) to deeply integrate with system functionality: such as Widgets, Share Extensions, and Safari Extensions. With a little setup, you can create App Extensions with xtool.
This guide will show you how to add a **Widget Extension** to your app. The steps are similar for other extensions as well.
> Note: This guide assumes you already have an xtool-based application up and running. If you don't, create one first with <doc:First-app>.
## Step 1: Add a new product
Start by adding a new product declaration to your `Package.swift`.
```diff
// swift-tools-version: 6.0
import PackageDescription
let package = Package(
name: "Hello",
platforms: [.iOS(.v17)],
products: [
.library(
name: "Hello",
targets: ["Hello"]
),
+ .library(
+ name: "HelloWidget",
+ targets: ["HelloWidget"]
+ ),
],
targets: [
.target(name: "Hello"),
+ .target(name: "HelloWidget"),
]
)
```
## Step 2: Update xtool.yml
Now that we have two products, we'll need to tell xtool which one corresponds to the _application_ and which one corresponds to the _extension_.
You should already have a bare-bones `xtool.yml` file that describes metadata about your package (the bundle ID, at the bare minimum.) We'll add the new information to this file.
```diff
version: 1
bundleID: com.example.Hello
+ product: Hello
+ extensions:
+ - product: HelloWidget
+ infoPath: HelloWidget-Info.plist
```
## Step 3: Add an Info.plist
App extensions require an `Info.plist` file that tells the system what kind of extension they are, amongst other things. In the previous step, we promised xtool that this file will be located at `./HelloWidget-Info.plist` in your project. We'll now create this file.
```xml
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>NSExtension</key>
<dict>
<key>NSExtensionPointIdentifier</key>
<string>com.apple.widgetkit-extension</string>
</dict>
</dict>
</plist>
```
> Note:
>
> The value `com.apple.widgetkit-extension` tells the system that this is a Widget Extension. If you're creating a different type of Extension, your `Info.plist` might look different.
>
> For a list of possible `NSExtensionPointIdentifier` values, see [Apple's documentation](https://developer.apple.com/documentation/bundleresources/information-property-list/nsextension/nsextensionpointidentifier) on the subject. You may also need other keys like `NSExtensionPrincipalClass`: refer to Apple's ~better~ legacy [documentation library](https://developer.apple.com/library/archive/documentation/General/Reference/InfoPlistKeyReference/Articles/AppExtensionKeys.html) for details.
>
> Finally, note that the above refers to the old paradigm of **Foundation Extensions**. Apple has started moving towards a newer framework called **ExtensionKit** for recent extension types. The main difference for extension consumers is that you replace `NSExtension -> EXAppExtensionAttributes`, and `NSExtensionPointIdentifier -> EXExtensionPointIdentifier`. xtool doesn't support ExtensionKit yet, but it's [planned](https://github.com/xtool-org/xtool/issues/138).
## Step 4: Code your widget
We can finally write the code for the widget. Create a new file at `Sources/HelloWidget/Widget.swift` with these contents:
```swift
import WidgetKit
import SwiftUI
@main struct Bundle: WidgetBundle {
var body: some Widget {
HelloWidget()
}
}
struct HelloWidget: Widget {
var body: some WidgetConfiguration {
StaticConfiguration(
kind: "HelloWidget",
provider: Provider()
) { entry in
VStack {
Text(entry.date, style: .date)
}
.containerBackground(.fill.tertiary, for: .widget)
}
.configurationDisplayName("HelloWidget")
.description("This is an example widget.")
}
struct Entry: TimelineEntry {
var date = Date()
}
struct Provider: TimelineProvider {
func placeholder(in context: Context) -> Entry {
Entry()
}
func getSnapshot(
in context: Context,
completion: @escaping (Entry) -> Void
) {
completion(Entry())
}
func getTimeline(
in context: Context,
completion: @escaping (Timeline<Entry>) -> Void
) {
completion(Timeline(
entries: [Entry()],
policy: .after(.now + 3600)
))
}
}
}
```
> Note: Blindly refreshing once an hour isn't a great strategy in practice but it makes for a short snippet. I never said this was a tutorial on writing _good_ WidgetKit code; there's plenty of other resources online if that's your goal, including Apple's own [documentation](https://developer.apple.com/documentation/widgetkit).
Finally, build and run with `xtool dev`. You should be able to locate the widget in your widget library and add it to your home screen!
-19
View File
@@ -1,19 +0,0 @@
<style>
footer {
display: flex;
justify-content: center;
padding: 0.5rem 0.8rem;
background-color: var(--color-fill-secondary);
text-align: center;
}
a, a:visited {
color: var(--color-text);
}
</style>
<footer>
<span>
&copy; xtool maintainers. This site is powered by <a href="https://www.netlify.com">Netlify</a>.
</span>
</footer>
+6 -7
View File
@@ -5,6 +5,9 @@ shopt -s nullglob
cd "$(dirname "$0")"
# installer version
export LINUXDEPLOY_OUTPUT_VERSION="1.0.0"
if ! command -v fusermount &>/dev/null; then
# Docker doesn't support FUSE
export APPIMAGE_EXTRACT_AND_RUN=1
@@ -18,7 +21,6 @@ bin="$(swift build --package-path .. -c release --show-bin-path)"
strip "${bin}/xtool"
curr_git_info="$(curl -fsSL https://api.github.com/repos/linuxdeploy/linuxdeploy/git/refs/tags/continuous)"
curr_arch="$(uname -m)"
if [[ -f staging/linuxdeploy/git.json ]]; then
if ! cmp -s staging/linuxdeploy/git.json <(echo "$curr_git_info"); then
@@ -31,7 +33,7 @@ else
fi
if [[ ! -f staging/linuxdeploy/linuxdeploy.AppImage ]]; then
curl -fsSL "https://github.com/linuxdeploy/linuxdeploy/releases/download/continuous/linuxdeploy-${curr_arch}.AppImage" \
curl -fsSL "https://github.com/linuxdeploy/linuxdeploy/releases/download/continuous/linuxdeploy-$(arch).AppImage" \
-o staging/linuxdeploy/linuxdeploy.AppImage
chmod +x staging/linuxdeploy/linuxdeploy.AppImage
echo "$curr_git_info" > staging/linuxdeploy/git.json
@@ -40,17 +42,14 @@ fi
mkdir -p staging/tmp/AppDir/usr/bin
find "${bin}"/ -name '*.resources' -print0 | xargs -0 -I {} cp -a {} "${PWD}/staging/tmp/AppDir/usr/bin/"
export LINUXDEPLOY_OUTPUT_VERSION="${XTOOL_VERSION:-unversioned}"
export LDAI_OUTPUT="staging/tmp/xtool-${curr_arch}.AppImage"
export LDAI_UPDATE_INFORMATION="gh-releases-zsync|xtool-org|xtool|latest|xtool-${curr_arch}.AppImage.zsync"
./staging/linuxdeploy/linuxdeploy.AppImage \
LDAI_OUTPUT="staging/tmp/xtool.AppImage" ./staging/linuxdeploy/linuxdeploy.AppImage \
--appdir staging/tmp/AppDir \
--output appimage \
-e "${bin}/xtool" \
-d xtool.desktop \
-i xtool.png
mkdir -p packages
mv -f "staging/tmp/xtool-${curr_arch}.AppImage" "./xtool-${curr_arch}.AppImage.zsync" packages/
mv -f staging/tmp/xtool.AppImage packages/xtool.AppImage
rm -rf staging/tmp
+5 -155
View File
@@ -1,152 +1,7 @@
ifeq ($(shell uname -s),Darwin)
IS_MAC = 1
ifneq ($(VERBOSE),1)
ifeq ($(shell type -p xcbeautify &>/dev/null && echo 1),1)
XC_FORMAT = | xcbeautify
endif
endif
endif
ifeq ($(RELEASE),1)
INTERNAL_SWIFTFLAGS = -c release
INTERNAL_XCFLAGS = -configuration Release
else
INTERNAL_SWIFTFLAGS = -c debug
INTERNAL_XCFLAGS = -configuration Debug
endif
ALL_SWIFTFLAGS = $(INTERNAL_SWIFTFLAGS) $(SWIFTFLAGS)
ALL_XCFLAGS = $(INTERNAL_XCFLAGS) $(XCFLAGS)
TEAM_CONFIG = macOS/Support/Private-Team.xcconfig
.PHONY: all
# dev build for the current platform
all:
ifeq ($(IS_MAC),1)
@+$(MAKE) mac
else
@+$(MAKE) linux
endif
.PHONY: clean
# clean build artifacts
clean:
ifeq ($(IS_MAC),1)
@+$(MAKE) mac-clean
else
@+$(MAKE) linux-clean
endif
.PHONY: linux
# dev build for Linux
linux:
swift build --product xtool $(ALL_SWIFTFLAGS)
.PHONY: linux-clean
# clean build artifacts for Linux
linux-clean:
rm -rf .build
.PHONY: linux-dist
# dist build for Linux
linux-dist:
docker compose run --build --rm xtool Linux/build.sh
.PHONY: mac
# dev build for macOS
mac: project
@rm -rf macOS/Build/XcodeInstall
@set -o pipefail && cd macOS && \
xcodebuild install \
-skipMacroValidation -skipPackagePluginValidation \
-scheme XToolMac -destination generic/platform=macOS \
-derivedDataPath Build/DerivedData \
DSTROOT="$$PWD"/Build/XcodeInstall INSTALL_PATH=/ \
$(ALL_XCFLAGS) $(XC_FORMAT)
@ln -fs XcodeInstall/xtool.app/Contents/Resources/bin/xtool macOS/Build/xtool
@echo "Output: ./macOS/Build/xtool"
.PHONY: mac-clean
# clean build artifacts for macOS
mac-clean:
rm -rf macOS/Build
.PHONY: mac-dist
# dist build for macOS
# requires a few secrets in the env (see .github/workflows/release.yml)
mac-dist:
@echo "bundle exec fastlane package"
@cd macOS && bundle exec fastlane package
.PHONY: reload
# update Xcode project and restart Xcode
reload:
killall Xcode || :
@+$(MAKE) project
xed macOS/XToolMac.xcodeproj
.PHONY: project
# update Xcode project
project: $(TEAM_CONFIG)
@echo "xcodegen"
@cd macOS && xcodegen
.PHONY: team
# update development team
team:
@+$(MAKE) -B $(TEAM_CONFIG)
# update development team if needed.
#
# will prompt interactively if there are multiple valid options.
# set DEVELOPMENT_TEAM=... to force a specific value.
$(TEAM_CONFIG):
ifeq ($(DEVELOPMENT_TEAM),)
@mkdir -p macOS/Support
@team=$$(./scripts/select-identity.sh); \
echo "echo \"DEVELOPMENT_TEAM = $$team\" > $@"; \
echo "DEVELOPMENT_TEAM = $$team" > $@
else
@mkdir -p macOS/Support
echo "DEVELOPMENT_TEAM = $(DEVELOPMENT_TEAM)" > $@
.PHONY: $(TEAM_CONFIG)
endif
.PHONY: docs
# build documentation
docs:
./Documentation/build.sh
.PHONY: docs-preview
# preview documentation
docs-preview:
./Documentation/build.sh preview
SWIFTLINT_VERSION = $(shell head -1 .swiftlint.yml | cut -d' ' -f2)
SWIFTLINT_BIN = .tmp/swiftlint/swiftlint-$(SWIFTLINT_VERSION)
SWIFTLINT_URL = https://github.com/realm/SwiftLint/releases/download/$(SWIFTLINT_VERSION)/$(if $(IS_MAC),portable_swiftlint,swiftlint_linux).zip
.PHONY: lint
lint: $(SWIFTLINT_BIN)
$(SWIFTLINT_BIN) $(SWIFTLINT_FLAGS)
$(SWIFTLINT_BIN):
@rm -rf .tmp/swiftlint
@mkdir -p .tmp/swiftlint
curl -fSL $(SWIFTLINT_URL) -o .tmp/swiftlint/swiftlint.zip
unzip -q .tmp/swiftlint/swiftlint.zip swiftlint -d .tmp/swiftlint
@rm -f .tmp/swiftlint/swiftlint.zip
@mv .tmp/swiftlint/swiftlint $@
@ln -s swiftlint-$(SWIFTLINT_VERSION) .tmp/swiftlint/swiftlint
SPEC_URL = https://developer.apple.com/sample-code/app-store-connect/app-store-connect-openapi-specification.zip
.PHONY: api
# Regenerate the OpenAPI client code
.PHONY: api update-api
api: openapi/openapi.json
swift run swift-openapi-generator generate \
openapi/openapi.json \
@@ -156,17 +11,12 @@ api: openapi/openapi.json
sed -i '' -e 's/[[:<:]]Client[[:>:]]/DeveloperAPIClient/g' $$file; \
done
.PHONY: update-api
# Update OpenAPI spec and regenerate the client code
update-api:
@+$(MAKE) -B api
openapi/openapi.json: openapi/base.json Sources/DeveloperAPI/patch.js
node Sources/DeveloperAPI/patch.js < openapi/base.json > openapi/openapi.json
openapi/openapi.json: openapi/base.json Sources/DeveloperAPI/openapi-overlay.yaml
npx bump-cli overlay openapi/base.json Sources/DeveloperAPI/openapi-overlay.yaml > openapi/openapi.json
openapi/base.json:
@mkdir -p openapi
# piping curl|bsdtar concatenates xattrs into the JSON :thonk:
curl -fsSL "$(SPEC_URL)" -o openapi/spec.zip
bsdtar -xO -f openapi/spec.zip > openapi/base.json
rm -f openapi/spec.zip
curl -fsSL "$(SPEC_URL)" | bsdtar -xOf- > openapi/base.json
+83 -128
View File
@@ -1,13 +1,13 @@
{
"originHash" : "eb2a57fb4e4c2c83ff1f1fa55631db81988fc6e2e576a05a3cc5c8ed69432c3a",
"originHash" : "6980154be7e8da0aace058cc72033471d7d9573fa77fdbf53972129e4cd1d0a2",
"pins" : [
{
"identity" : "aexml",
"kind" : "remoteSourceControl",
"location" : "https://github.com/tadija/AEXML.git",
"state" : {
"revision" : "db806756c989760b35108146381535aec231092b",
"version" : "4.7.0"
"revision" : "38f7d00b23ecd891e1ee656fa6aeebd6ba04ecc3",
"version" : "4.6.1"
}
},
{
@@ -15,8 +15,8 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/swift-server/async-http-client.git",
"state" : {
"revision" : "3a5b74a58782c3b4c1f0bc75e9b67b10c2494e8f",
"version" : "1.33.1"
"revision" : "333f51104b75d1a5b94cb3b99e4c58a3b442c9f7",
"version" : "1.25.2"
}
},
{
@@ -24,8 +24,8 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/attaswift/BigInt",
"state" : {
"revision" : "e07e00fa1fd435143a2dcf8b7eec9a7710b2fdfe",
"version" : "5.7.0"
"revision" : "114343a705df4725dfe7ab8a2a326b8883cfd79c",
"version" : "5.5.1"
}
},
{
@@ -33,8 +33,8 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/pointfreeco/combine-schedulers",
"state" : {
"revision" : "dcccb979a2183b8df3334237e3dc1ae2b4116a86",
"version" : "1.2.0"
"revision" : "5928286acce13def418ec36d05a001a9641086f2",
"version" : "1.0.3"
}
},
{
@@ -51,8 +51,8 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/mattpolzin/OpenAPIKit",
"state" : {
"revision" : "57b6318128e3f901c93f4fbf98d1c1464ec168d3",
"version" : "6.2.0"
"revision" : "da7d3a5ddff0dd8e5e9fdb5585d186d645bcc21b",
"version" : "3.5.0"
}
},
{
@@ -69,8 +69,8 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/onevcat/Rainbow.git",
"state" : {
"revision" : "cdf146ae671b2624917648b61c908d1244b98ca1",
"version" : "4.2.1"
"revision" : "0c627a4f8a39ef37eadec1ceec02e4a7f55561ac",
"version" : "4.1.0"
}
},
{
@@ -96,8 +96,8 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/apple/swift-argument-parser",
"state" : {
"revision" : "626b5b7b2f45e1b0b1c6f4a309296d1d21d7311b",
"version" : "1.7.1"
"revision" : "41982a3656a71c768319979febd796c6fd111d5c",
"version" : "1.5.0"
}
},
{
@@ -105,17 +105,8 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/apple/swift-asn1.git",
"state" : {
"revision" : "eb50cbd14606a9161cbc5d452f18797c90ef0bab",
"version" : "1.7.0"
}
},
{
"identity" : "swift-async-algorithms",
"kind" : "remoteSourceControl",
"location" : "https://github.com/apple/swift-async-algorithms.git",
"state" : {
"revision" : "9d349bcc328ac3c31ce40e746b5882742a0d1272",
"version" : "1.1.3"
"revision" : "a54383ada6cecde007d374f58f864e29370ba5c3",
"version" : "1.3.2"
}
},
{
@@ -123,8 +114,8 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/apple/swift-atomics.git",
"state" : {
"revision" : "b601256eab081c0f92f059e12818ac1d4f178ff7",
"version" : "1.3.0"
"revision" : "cd142fd2f64be2100422d658e7411e39489da985",
"version" : "1.2.0"
}
},
{
@@ -132,8 +123,8 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/apple/swift-certificates",
"state" : {
"revision" : "bde8ca32a096825dfce37467137c903418c1893d",
"version" : "1.19.1"
"revision" : "999fd70c7803da89f3904d635a6815a2a7cd7585",
"version" : "1.10.0"
}
},
{
@@ -148,10 +139,10 @@
{
"identity" : "swift-collections",
"kind" : "remoteSourceControl",
"location" : "https://github.com/apple/swift-collections",
"location" : "https://github.com/apple/swift-collections.git",
"state" : {
"revision" : "fea17c02d767f46b23070fdfdacc28a03a39232a",
"version" : "1.5.1"
"revision" : "671108c96644956dddcd89dd59c203dcdb36cec7",
"version" : "1.1.4"
}
},
{
@@ -159,17 +150,8 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/pointfreeco/swift-concurrency-extras",
"state" : {
"revision" : "5a3825302b1a0d744183200915a47b508c828e6f",
"version" : "1.3.2"
}
},
{
"identity" : "swift-configuration",
"kind" : "remoteSourceControl",
"location" : "https://github.com/apple/swift-configuration.git",
"state" : {
"revision" : "be76c4ad929eb6c4bcaf3351799f2adf9e6848a9",
"version" : "1.2.0"
"revision" : "82a4ae7170d98d8538ec77238b7eb8e7199ef2e8",
"version" : "1.3.1"
}
},
{
@@ -177,8 +159,8 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/apple/swift-crypto",
"state" : {
"revision" : "1b6b2e274e85105bfa155183145a1dcfd63331f1",
"version" : "4.5.0"
"revision" : "e8d6eba1fef23ae5b359c46b03f7d94be2f41fed",
"version" : "3.12.3"
}
},
{
@@ -186,26 +168,17 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/pointfreeco/swift-dependencies",
"state" : {
"revision" : "706feb7858a7f6c242879d137b8ee30926aa5b26",
"version" : "1.12.0"
}
},
{
"identity" : "swift-distributed-tracing",
"kind" : "remoteSourceControl",
"location" : "https://github.com/apple/swift-distributed-tracing.git",
"state" : {
"revision" : "dc4030184203ffafbb2ec614352487235d747fe0",
"version" : "1.4.1"
"revision" : "4c90d6b2b9bf0911af87b103bb40f41771891596",
"version" : "1.9.2"
}
},
{
"identity" : "swift-docc-plugin",
"kind" : "remoteSourceControl",
"location" : "https://github.com/swiftlang/swift-docc-plugin",
"location" : "https://github.com/apple/swift-docc-plugin",
"state" : {
"revision" : "647c708be89f834fa6a6d4945442793a77ddf5b6",
"version" : "1.5.0"
"revision" : "85e4bb4e1cd62cec64a4b8e769dcefdf0c5b9d64",
"version" : "1.4.3"
}
},
{
@@ -222,8 +195,8 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/apple/swift-http-structured-headers.git",
"state" : {
"revision" : "933538faa42c432d385f02e07df0ace7c5ecfc47",
"version" : "1.7.0"
"revision" : "f280fc7676b9940ff2c6598642751ea333c6544f",
"version" : "1.2.2"
}
},
{
@@ -231,8 +204,8 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/apple/swift-http-types",
"state" : {
"revision" : "45eb0224913ea070ec4fba17291b9e7ecf4749ca",
"version" : "1.5.1"
"revision" : "a0a57e949a8903563aba4615869310c0ebf14c03",
"version" : "1.4.0"
}
},
{
@@ -240,8 +213,8 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/apple/swift-log.git",
"state" : {
"revision" : "5073617dac96330a486245e4c0179cb0a6fd2256",
"version" : "1.12.0"
"revision" : "3d8596ed08bd13520157f0355e35caed215ffbfa",
"version" : "1.6.3"
}
},
{
@@ -249,8 +222,8 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/apple/swift-nio",
"state" : {
"revision" : "f71c8d2a5e74a2c6d11a0fbe324774b5d6084237",
"version" : "2.99.0"
"revision" : "0f54d58bb5db9e064f332e8524150de379d1e51c",
"version" : "2.82.1"
}
},
{
@@ -258,8 +231,8 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/apple/swift-nio-extras.git",
"state" : {
"revision" : "5a48717e29f62cb8326d6d42e46b562ca93847a6",
"version" : "1.34.0"
"revision" : "f1f6f772198bee35d99dd145f1513d8581a54f2c",
"version" : "1.26.0"
}
},
{
@@ -267,8 +240,8 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/apple/swift-nio-http2.git",
"state" : {
"revision" : "81cc18264f92cd307ff98430f89372711d4f6fe9",
"version" : "1.43.0"
"revision" : "4281466512f63d1bd530e33f4aa6993ee7864be0",
"version" : "1.36.0"
}
},
{
@@ -276,8 +249,8 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/apple/swift-nio-ssl.git",
"state" : {
"revision" : "3f337058ccd7243c4cac7911477d8ad4c598d4da",
"version" : "2.37.0"
"revision" : "6df102a39c8da5fdc2eae29a0f63546d660866fc",
"version" : "2.30.0"
}
},
{
@@ -285,8 +258,8 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/apple/swift-nio-transport-services.git",
"state" : {
"revision" : "67787bb645a5e67d2edcdfbe48a216cc549222d5",
"version" : "1.28.0"
"revision" : "cd1e89816d345d2523b11c55654570acd5cd4c56",
"version" : "1.24.0"
}
},
{
@@ -294,8 +267,8 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/apple/swift-numerics.git",
"state" : {
"revision" : "0c0290ff6b24942dadb83a929ffaaa1481df04a2",
"version" : "1.1.1"
"revision" : "e0ec0f5f3af6f3e4d5e7a19d2af26b481acb6ba8",
"version" : "1.0.3"
}
},
{
@@ -303,8 +276,8 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/swift-server/swift-openapi-async-http-client",
"state" : {
"revision" : "3681f659d9417652b8119f0adbdf57c04b6cb292",
"version" : "1.5.0"
"revision" : "915aeff168625b0f88a5810ee7ab8e9c00af671b",
"version" : "1.1.0"
}
},
{
@@ -312,8 +285,8 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/apple/swift-openapi-generator",
"state" : {
"revision" : "5dd0da1c7da7bac8f0c458a02a76f69031137a80",
"version" : "1.12.1"
"revision" : "02cab48b66b4b412013827c2938adaf0eb67dc8d",
"version" : "1.7.2"
}
},
{
@@ -321,8 +294,8 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/apple/swift-openapi-runtime",
"state" : {
"revision" : "f039fa6d6338aab5164f3d1be16281524c9a8f89",
"version" : "1.11.0"
"revision" : "8f33cc5dfe81169fb167da73584b9c72c3e8bc23",
"version" : "1.8.2"
}
},
{
@@ -330,26 +303,8 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/apple/swift-openapi-urlsession",
"state" : {
"revision" : "576a65b4ffb8c12ddad4950dc21eea2ef071bec2",
"version" : "1.3.0"
}
},
{
"identity" : "swift-service-context",
"kind" : "remoteSourceControl",
"location" : "https://github.com/apple/swift-service-context.git",
"state" : {
"revision" : "d0997351b0c7779017f88e7a93bc30a1878d7f29",
"version" : "1.3.0"
}
},
{
"identity" : "swift-service-lifecycle",
"kind" : "remoteSourceControl",
"location" : "https://github.com/swift-server/swift-service-lifecycle",
"state" : {
"revision" : "9829955b385e5bb88128b73f1b8389e9b9c3191a",
"version" : "2.11.0"
"revision" : "6fac6f7c428d5feea2639b5f5c8b06ddfb79434b",
"version" : "1.1.0"
}
},
{
@@ -357,8 +312,8 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/swiftlang/swift-syntax",
"state" : {
"revision" : "9de99a78f099e59caf2b2beec65a4c45d54b2081",
"version" : "603.0.1"
"revision" : "f99ae8aa18f0cf0d53481901f88a0991dc3bd4a2",
"version" : "601.0.1"
}
},
{
@@ -366,8 +321,8 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/apple/swift-system",
"state" : {
"revision" : "7c6ad0fc39d0763e0b699210e4124afd5041c5df",
"version" : "1.6.4"
"revision" : "a34201439c74b53f0fd71ef11741af7e7caf01e1",
"version" : "1.4.2"
}
},
{
@@ -384,8 +339,8 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/xtool-org/SwiftyMobileDevice",
"state" : {
"revision" : "280d0dc8153469944491aee2f19af29e9c7a77f0",
"version" : "1.5.0"
"revision" : "5ee5f680d065519dd6ac56c96435a7db0d599ade",
"version" : "1.4.0"
}
},
{
@@ -393,8 +348,8 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/saagarjha/unxip",
"state" : {
"revision" : "6c3990517fcc4c1db6952fccf4c562fb14097601",
"version" : "3.3.0"
"revision" : "d6f0009109f7502f8f5b3f23dcd5b43cf5b29b32",
"version" : "3.1.0"
}
},
{
@@ -402,8 +357,8 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/mxcl/Version",
"state" : {
"revision" : "3043fcd2a50375db76d89ff206a612471833d1c2",
"version" : "2.2.1"
"revision" : "303a0f916772545e1e8667d3104f83be708a723c",
"version" : "2.1.0"
}
},
{
@@ -411,8 +366,8 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/vapor/websocket-kit.git",
"state" : {
"revision" : "90bbbdab3ede12c803cfbe91646f291c092517a3",
"version" : "2.16.2"
"revision" : "014ccd52891b8c098d7e1033d5e72ed76fef7a86",
"version" : "2.16.0"
}
},
{
@@ -420,8 +375,8 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/yonaskolb/XcodeGen",
"state" : {
"revision" : "8d3d3476a69ae3e5d68e1adccc701c410c05eb36",
"version" : "2.45.4"
"revision" : "7193eb447a6f60061f069e07bc1efd32d73c0e19",
"version" : "2.43.0"
}
},
{
@@ -429,8 +384,8 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/tuist/XcodeProj.git",
"state" : {
"revision" : "01bb77000bc8c23a09ea2058f4954612f03cb705",
"version" : "9.10.1"
"revision" : "dc3b87a4e69f9cd06c6cb16199f5d0472e57ef6b",
"version" : "8.24.3"
}
},
{
@@ -438,8 +393,8 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/pointfreeco/xctest-dynamic-overlay",
"state" : {
"revision" : "dfd70507def84cb5fb821278448a262c6ff2bbad",
"version" : "1.9.0"
"revision" : "39de59b2d47f7ef3ca88a039dff3084688fe27f4",
"version" : "1.5.2"
}
},
{
@@ -447,8 +402,8 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/xtool-org/xtool-core",
"state" : {
"revision" : "d412ac768d1e73d16ad7ccc6805f12fc701709f6",
"version" : "1.4.0"
"revision" : "63c644eef014f7faff53daaebe8bad37c31fbbe5",
"version" : "1.3.0"
}
},
{
@@ -456,8 +411,8 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/jpsim/Yams",
"state" : {
"revision" : "3d6871d5b4a5cd519adf233fbb576e0a2af71c17",
"version" : "5.4.0"
"revision" : "b4b8042411dc7bbb696300a34a4bf3ba1b7ad19b",
"version" : "5.3.1"
}
},
{
@@ -465,8 +420,8 @@
"kind" : "remoteSourceControl",
"location" : "https://github.com/xtool-org/zsign",
"state" : {
"revision" : "6c4a9f52dd8bf374aa938ef9c17d5f261f2c333a",
"version" : "1.7.0"
"revision" : "e9853fd3be36ea1a61fa9d4b7f71f4b4d8244369",
"version" : "1.4.0"
}
}
],
+25 -38
View File
@@ -2,19 +2,6 @@
import PackageDescription
let xtoolVersion: String? = {
if let explicitVersion = Context.environment["XTOOL_VERSION"] {
return explicitVersion
} else if let info = Context.gitInformation {
let gitCommit = info.currentCommit
let gitTag = info.currentTag
let gitRef = gitTag ?? "commit \(gitCommit)"
return "\(gitRef)\(info.hasUncommittedChanges ? " (dirty)" : "")"
} else {
return nil
}
}()
let cSettings: [CSetting] = [
.define("_GNU_SOURCE", .when(platforms: [.linux])),
]
@@ -22,8 +9,8 @@ let cSettings: [CSetting] = [
let package = Package(
name: "xtool",
platforms: [
.iOS(.v16),
.macOS(.v13),
.iOS(.v15),
.macOS(.v12),
],
products: [
.library(
@@ -40,21 +27,20 @@ let package = Package(
),
],
dependencies: [
.package(url: "https://github.com/xtool-org/xtool-core", .upToNextMinor(from: "1.4.0")),
.package(url: "https://github.com/xtool-org/SwiftyMobileDevice", .upToNextMinor(from: "1.5.0")),
.package(url: "https://github.com/xtool-org/zsign", .upToNextMinor(from: "1.7.0")),
.package(url: "https://github.com/xtool-org/xtool-core", .upToNextMinor(from: "1.3.0")),
.package(url: "https://github.com/xtool-org/SwiftyMobileDevice", .upToNextMinor(from: "1.4.0")),
.package(url: "https://github.com/xtool-org/zsign", .upToNextMinor(from: "1.4.0")),
.package(url: "https://github.com/apple/swift-system", from: "1.4.0"),
.package(url: "https://github.com/apple/swift-http-types", from: "1.3.1"),
.package(url: "https://github.com/apple/swift-certificates", from: "1.0.0"),
.package(url: "https://github.com/apple/swift-crypto", from: "4.5.0"),
.package(url: "https://github.com/apple/swift-crypto", from: "3.9.1"),
.package(url: "https://github.com/apple/swift-argument-parser", from: "1.5.0"),
.package(url: "https://github.com/apple/swift-openapi-generator", from: "1.6.0"),
.package(url: "https://github.com/apple/swift-openapi-runtime", from: "1.0.0"),
.package(url: "https://github.com/apple/swift-openapi-urlsession", from: "1.0.0"),
.package(url: "https://github.com/apple/swift-nio", from: "2.77.0"),
.package(url: "https://github.com/swiftlang/swift-docc-plugin", from: "1.0.0"),
.package(url: "https://github.com/apple/swift-docc-plugin", from: "1.0.0"),
.package(url: "https://github.com/swift-server/async-http-client.git", from: "1.23.0"),
.package(url: "https://github.com/swift-server/swift-openapi-async-http-client", from: "1.0.0"),
@@ -66,10 +52,10 @@ let package = Package(
.package(url: "https://github.com/attaswift/BigInt", from: "5.5.0"),
.package(url: "https://github.com/mxcl/Version", from: "2.1.0"),
.package(url: "https://github.com/jpsim/Yams", from: "5.1.3"),
.package(url: "https://github.com/saagarjha/unxip", from: "3.2.0"),
.package(url: "https://github.com/saagarjha/unxip", from: "3.1.0"),
// TODO: just depend on tuist/XcodeProj instead
.package(url: "https://github.com/yonaskolb/XcodeGen", from: "2.45.4"),
.package(url: "https://github.com/yonaskolb/XcodeGen", from: "2.43.0"),
],
targets: [
.systemLibrary(name: "XADI"),
@@ -78,32 +64,20 @@ let package = Package(
dependencies: [
.product(name: "OpenSSL", package: "xtool-core")
],
cSettings: cSettings + (
xtoolVersion
.map { [.define("XTOOL_VERSION", to: "\"\($0)\"")] }
?? []
)
cSettings: cSettings
),
.target(
name: "DeveloperAPI",
dependencies: [
.product(name: "OpenAPIRuntime", package: "swift-openapi-runtime"),
],
exclude: ["openapi-generator-config.yaml", "patch.js"]
),
// common utilities shared across xtool targets
.target(
name: "XUtils",
dependencies: [
.product(name: "SystemPackage", package: "swift-system"),
]
exclude: ["openapi-generator-config.yaml", "openapi-overlay.yaml"]
),
.target(
name: "XKit",
dependencies: [
"DeveloperAPI",
"CXKit",
"XUtils",
.byName(name: "XADI", condition: .when(platforms: [.linux])),
.product(name: "ConcurrencyExtras", package: "swift-concurrency-extras"),
.product(name: "Dependencies", package: "swift-dependencies"),
@@ -143,6 +117,20 @@ let package = Package(
"XToolSupport",
]
),
.testTarget(
name: "XKitTests",
dependencies: [
"XKit",
.product(name: "SuperutilsTestSupport", package: "xtool-core")
],
exclude: [
"config/config-template.json",
],
resources: [
.copy("config/config.json"),
.copy("config/test.app"),
]
),
.target(
name: "XToolSupport",
dependencies: [
@@ -160,7 +148,6 @@ let package = Package(
.target(
name: "PackLib",
dependencies: [
"XUtils",
.product(name: "Yams", package: "Yams"),
.product(name: "XcodeGenKit", package: "XcodeGen", condition: .when(platforms: [.macOS])),
]
+5 -5
View File
@@ -1,6 +1,6 @@
# xtool
Cross-platform Xcode replacement. Build and deploy iOS apps with SwiftPM on Linux, Windows, and macOS.
Cross-platform Xcode replacement. Build and deploy iOS apps with SwiftPM on Linux and macOS.
## Overview
@@ -15,15 +15,15 @@ xtool is a cross-platform (Linux/WSL/macOS) tool that replicates Xcode functiona
## Getting Started
1. Follow the guide to install `xtool`
- [Installation (Linux/Windows)](https://xtool.sh/documentation/xtooldocs/installation-linux)
- [Installation (macOS)](https://xtool.sh/documentation/xtooldocs/installation-macos)
2. Create and run your first xtool-powered app by following the [tutorial](https://xtool.sh/tutorials/xtooldocs/first-app)!
- [Installation (Linux)](https://swiftpackageindex.com/xtool-org/xtool/documentation/xtool/installation-linux)
- [Installation (macOS)](https://swiftpackageindex.com/xtool-org/xtool/documentation/xtool/installation-macos)
2. Create and run your first xtool-powered app by following the [tutorial](https://swiftpackageindex.com/xtool-org/xtool/tutorials/xtool/first-app)!
## Examples
### Screenshot
![A screenshot of xtool being invoked from VSCode](Documentation/xtool.docc/Resources/Cover.png)
![A screenshot of xtool being invoked from VSCode](Sources/xtool/Documentation.docc/Resources/Cover.png)
### Command line interface
-5
View File
@@ -1,5 +0,0 @@
# Security Policy
## Reporting a Vulnerability
To report a vulnerability, please use GitHub's ["Report a Vulnerability"](https://github.com/xtool-org/xtool/security/advisories/new) tab. We'll be in touch regarding next steps.
-1
View File
@@ -1 +0,0 @@
const char * _Nonnull xtl_version(void);
-8
View File
@@ -18,8 +18,6 @@ struct mobileprovision {
static mobileprovision_t mobileprovision_create(PKCS7 *raw) {
mobileprovision_t profile = malloc(sizeof(struct mobileprovision));
if (!profile) return NULL;
profile->raw = raw;
return profile;
}
@@ -43,12 +41,6 @@ void *mobileprovision_copy_data(mobileprovision_t profile, size_t *len) {
if (data_len < 0) return NULL;
*len = data_len;
void *ret = malloc(data_len);
if (!ret) {
OPENSSL_free(data);
return NULL;
}
memcpy(ret, data, data_len);
OPENSSL_free(data);
return ret;
-9
View File
@@ -1,9 +0,0 @@
#include "version.h"
const char *xtl_version(void) {
#ifdef XTOOL_VERSION
return XTOOL_VERSION;
#else
return "unversioned";
#endif
}
File diff suppressed because it is too large Load Diff
File diff suppressed because it is too large Load Diff
+22
View File
@@ -0,0 +1,22 @@
overlay: 1.0.0
info:
title: Overlay for App Store Connect API
version: 1.0.0
actions:
- target: '$.components.schemas.BundleIdCapabilityCreateRequest.properties.data.properties.relationships'
update:
properties:
capability:
type: object
properties:
data:
type: object
properties:
type:
type: string
enum: [capabilities]
id:
"$ref": "#/components/schemas/CapabilityType"
required: [id, type]
required: [data]
required: [capability]
-109
View File
@@ -1,109 +0,0 @@
#!/usr/bin/env node
import fs from 'fs';
function update(schema, value) {
for (const key in value) {
const val = value[key];
if (val === null) {
delete schema[key];
} else if (Array.isArray(val)) {
schema[key] = (schema[key] ?? []).concat(val);
} else if (typeof val === 'object') {
if (schema[key] === undefined) {
schema[key] = {};
}
update(schema[key], val);
} else {
schema[key] = val;
}
}
}
// in-place update
function replace(schema, value) {
Object.keys(schema).forEach(k => delete schema[k]);
Object.assign(schema, value);
}
function clone(schema) {
return JSON.parse(JSON.stringify(schema));
}
function makeOpen(enumSchema) {
replace(enumSchema, {
anyOf: [
clone(enumSchema),
{ type: 'string' },
]
});
}
function openAll(schema, path = []) {
if (Array.isArray(schema)) {
schema.forEach((s, i) => openAll(s, [...path, i]))
} else if (typeof schema === 'object' && schema !== null) {
const keys = new Set(Object.keys(schema))
if (keys.size === 2
&& keys.has('type')
&& keys.has('enum')
&& schema.type === 'string'
&& Array.isArray(schema.enum)) {
// several polymorphic schemas have a field literally named 'type', that always has a single case.
// skip that instance, but make all other enums open.
if (!(path[path.length - 1] === 'type' && schema.enum.length === 1)) {
makeOpen(schema);
}
} else {
for (const key in schema) {
openAll(schema[key], [...path, key]);
}
}
}
}
function patch(schema) {
const schemas = schema.components.schemas;
// this field is required iff using the private Xcode API
update(schemas.BundleIdCapabilityCreateRequest.properties.data.properties.relationships, {
properties: {
capability: {
type: 'object',
properties: {
data: {
type: 'object',
properties: {
type: {
type: 'string',
enum: ['capabilities'],
},
id: { $ref: '#/components/schemas/CapabilityType' },
},
required: ['id', 'type'],
},
},
required: ['data'],
}
},
})
// we don't use this but it triggers a deprecation warning. see:
// https://github.com/apple/swift-openapi-generator/issues/715
schemas.App.properties.relationships.properties.inAppPurchases.deprecated = false;
// openapi-generator expects response enums to be exhaustive. Apple's ASC OpenAPI spec
// misses some cases that they do, actually, return. So we make all bona fide enums in
// schema.components.schemas open. We don't do this on the schema.paths side because
// most (all?) of the enums in there are on the request side rather than the response.
// https://swiftpackageindex.com/apple/swift-openapi-generator/1.7.2/documentation/swift-openapi-generator/useful-openapi-patterns#Open-enums-and-oneOfs
openAll(schemas);
return schema;
}
const text = fs.readFileSync(process.stdin.fd, 'utf8');
const json = JSON.parse(text);
const patched = patch(json);
const patchedText = JSON.stringify(patched);
console.log(patchedText);
+3 -2
View File
@@ -15,14 +15,15 @@ public struct BuildSettings: Sendable {
public init(
configuration: BuildConfiguration,
triple: String,
packagePath: String = ".",
options: [String] = []
) async throws {
self.packagePath = packagePath
self.configuration = configuration
self.options = options
self.triple = triple
// TODO: allow customizing?
self.triple = "arm64-apple-ios"
// on macOS we don't explicitly install a Swift SDK but
// SwiftPM vends "implicit" Darwin SDKs as of Swift 6.1,
+56
View File
@@ -0,0 +1,56 @@
import Foundation
package struct TemporaryDirectory: ~Copyable {
private var shouldDelete = true
package let url: URL
package init(name: String) throws {
self.url = FileManager.default.temporaryDirectory.appendingPathComponent(name, isDirectory: true)
_delete()
try FileManager.default.createDirectory(at: url, withIntermediateDirectories: true)
}
private func _delete() {
try? FileManager.default.removeItem(at: url)
}
package consuming func persist() -> URL {
shouldDelete = false
return url
}
package consuming func persist(at location: URL) throws {
try FileManager.default.moveItem(at: url, to: location)
// we do this after moving, so that if the move fails we clean up
shouldDelete = false
}
deinit {
if shouldDelete { _delete() }
}
}
extension Data {
// AsyncBytes is Darwin-only :/
package init(reading fileHandle: FileHandle) async throws {
#if canImport(Darwin)
self = try await fileHandle.bytes.reduce(into: Data()) { $0.append($1) }
#else
self = try fileHandle.readToEnd() ?? Data()
#endif
}
package init(reading file: URL) async throws {
#if canImport(Darwin)
self = try await file.resourceBytes.reduce(into: Data()) { $0.append($1) }
#else
try self.init(contentsOf: file)
#endif
}
}
package func stderrPrint(_ message: String, terminator: String = "\n") {
try? FileHandle.standardError.write(contentsOf: Data("\(message)\(terminator)".utf8))
}
-21
View File
@@ -1,6 +1,5 @@
import Foundation
import Yams
import XUtils
public struct PackSchemaBase: Codable, Sendable {
public enum Version: Int, Codable, Sendable {
@@ -15,26 +14,11 @@ public struct PackSchemaBase: Codable, Sendable {
public var product: String?
public var infoPath: String?
public var entitlementsPath: String?
public var iconPath: String?
public var resources: [String]?
public var extensions: [Extension]?
public struct Extension: Codable, Sendable {
public var product: String
public var bundleID: String?
public var infoPath: String
public var resources: [String]?
public var entitlementsPath: String?
}
}
@dynamicMemberLookup
public struct PackSchema: Sendable {
public typealias Extension = PackSchemaBase.Extension
public enum IDSpecifier: Sendable {
case orgID(String)
case bundleID(String)
@@ -74,7 +58,6 @@ public struct PackSchema: Sendable {
}
}
// swiftlint:disable:next force_try
public static let `default` = try! PackSchema(validating: .init(
version: .v1,
orgID: "com.example"
@@ -85,8 +68,4 @@ public struct PackSchema: Sendable {
let base = try YAMLDecoder().decode(PackSchemaBase.self, from: data)
try self.init(validating: base)
}
public subscript<Subject>(dynamicMember keyPath: KeyPath<PackSchemaBase, Subject>) -> Subject {
self.base[keyPath: keyPath]
}
}
+74 -142
View File
@@ -1,5 +1,4 @@
import Foundation
import XUtils
public struct Packer: Sendable {
public let buildSettings: BuildSettings
@@ -21,44 +20,34 @@ public struct Packer: Sendable {
// swift-tools-version: 6.0
import PackageDescription
let package = Package(
name: "\(plan.app.product)-Builder",
name: "\(plan.product)-Builder",
platforms: [
.iOS("\(plan.app.deploymentTarget)"),
.iOS("\(plan.deploymentTarget)"),
],
dependencies: [
.package(name: "RootPackage", path: "../.."),
],
targets: [
\(
plan.allProducts.map {
"""
.executableTarget(
name: "\($0.targetName)",
dependencies: [
.product(name: "\($0.product)", package: "RootPackage"),
],
linkerSettings: \($0.linkerSettings)
)
"""
}
.joined(separator: ",\n")
)
.executableTarget(
name: "\(plan.product)-App",
dependencies: [
.product(name: "\(plan.product)", package: "RootPackage"),
]
),
]
)\n
"""
try Data(contents.utf8).write(to: packageSwift)
for product in plan.allProducts {
let sources: URL = packageDir.appendingPathComponent("Sources/\(product.targetName)", isDirectory: true)
try FileManager.default.createDirectory(at: sources, withIntermediateDirectories: true)
try Data().write(to: sources.appendingPathComponent("stub.c", isDirectory: false))
}
let sources = packageDir.appendingPathComponent("Sources")
try? FileManager.default.createDirectory(at: sources, withIntermediateDirectories: true)
try Data().write(to: sources.appendingPathComponent("stub.c"))
let builder = try await buildSettings.swiftPMInvocation(
forTool: "build",
arguments: [
"--package-path", packageDir.path,
"--scratch-path", ".build",
"--product", "\(plan.product)-App",
// resolving can cause SwiftPM to overwrite the root package deps
// with just the deps needed for the builder package (which is to
// say, any "dev dependencies" of the root package may be removed.)
@@ -66,6 +55,7 @@ public struct Packer: Sendable {
// in order to dump the plan, so we can skip resolution here to skirt
// the issue.
"--disable-automatic-resolution",
"-Xlinker", "-rpath", "-Xlinker", "@executable_path/Frameworks",
]
)
builder.standardOutput = FileHandle.standardError
@@ -75,49 +65,15 @@ public struct Packer: Sendable {
public func pack() async throws -> URL {
try await build()
let output = try TemporaryDirectory(name: "\(plan.app.product).app")
let outputURL = output.url
let output = try TemporaryDirectory(name: "\(plan.product).app")
let binDir = URL(
fileURLWithPath: ".build/\(buildSettings.triple)/\(buildSettings.configuration.rawValue)",
isDirectory: true
)
try await withThrowingTaskGroup(of: Void.self) { group in
for product in plan.allProducts {
try pack(
product: product,
binDir: binDir,
outputURL: product.directory(inApp: outputURL),
&group
)
}
let outputURL = output.url
while !group.isEmpty {
do {
try await group.next()
} catch is CancellationError {
// continue
} catch {
group.cancelAll()
throw error
}
}
}
let dest = URL(fileURLWithPath: "xtool").appendingPathComponent(outputURL.lastPathComponent)
try? FileManager.default.removeItem(at: dest)
try output.persist(at: dest)
return dest
}
@Sendable private func pack(
product: Plan.Product,
binDir: URL,
outputURL: URL,
_ group: inout ThrowingTaskGroup<Void, Error>
) throws {
@Sendable func packFileToRoot(srcName: String) async throws {
let srcURL = URL(fileURLWithPath: srcName)
let destURL = outputURL.appendingPathComponent(srcURL.lastPathComponent)
@@ -135,93 +91,69 @@ public struct Packer: Sendable {
try Task.checkCancellation()
}
// Ensure output directory is available
try? FileManager.default.createDirectory(at: outputURL, withIntermediateDirectories: true)
for command in product.resources {
try await withThrowingTaskGroup(of: Void.self) { group in
for command in plan.resources {
group.addTask {
switch command {
case .bundle(let package, let target):
try await packFile(srcName: "\(package)_\(target).bundle")
case .binaryTarget(let name):
let src = URL(fileURLWithPath: "\(name).framework/\(name)", relativeTo: binDir)
let magic = Data("!<arch>\n".utf8)
let thinMagic = Data("!<thin>\n".utf8)
let bytes = try FileHandle(forReadingFrom: src).read(upToCount: magic.count)
// if the magic matches one of these it's a static archive; don't embed it.
// https://github.com/apple/llvm-project/blob/e716ff14c46490d2da6b240806c04e2beef01f40/llvm/include/llvm/Object/Archive.h#L33
if bytes != magic && bytes != thinMagic {
try await packFile(srcName: "\(name).framework", dstName: "Frameworks/\(name).framework", sign: true)
}
case .library(let name):
try await packFile(srcName: "lib\(name).dylib", dstName: "Frameworks/lib\(name).dylib", sign: true)
case .root(let source):
try await packFileToRoot(srcName: source)
}
}
}
if let iconPath = plan.iconPath {
group.addTask {
try await packFileToRoot(srcName: iconPath)
}
}
group.addTask {
switch command {
case .bundle(let package, let target):
try await packFile(srcName: "\(package)_\(target).bundle")
case .binaryTarget(let name):
let src = URL(fileURLWithPath: "\(name).framework/\(name)", relativeTo: binDir)
let magic = Data("!<arch>\n".utf8)
let thinMagic = Data("!<thin>\n".utf8)
guard let bytes = try? FileHandle(forReadingFrom: src).read(upToCount: magic.count) else {
// if we can't find the binary, it might be a static framework that SwiftPM
// did not copy into the .build directory. we don't need to pack it anyway.
break
}
// if the magic matches one of these it's a static archive; don't embed it.
// https://github.com/apple/llvm-project/blob/e716ff14c46490d2da6b240806c04e2beef01f40/llvm/include/llvm/Object/Archive.h#L33
// swiftlint:disable:previous line_length
if bytes != magic && bytes != thinMagic {
try await packFile(srcName: "\(name).framework", dstName: "Frameworks/\(name).framework", sign: true)
}
case .library(let name):
try await packFile(srcName: "lib\(name).dylib", dstName: "Frameworks/lib\(name).dylib", sign: true)
case .root(let source):
try await packFileToRoot(srcName: source)
try await packFile(srcName: "\(plan.product)-App", dstName: plan.product)
}
group.addTask {
var info = plan.infoPlist
if let iconPath = plan.iconPath {
let iconName = URL(fileURLWithPath: iconPath).deletingPathExtension().lastPathComponent
info["CFBundleIconFile"] = iconName
}
let infoPath = outputURL.appendingPathComponent("Info.plist")
let encodedPlist = try PropertyListSerialization.data(
fromPropertyList: info,
format: .xml,
options: 0
)
try encodedPlist.write(to: infoPath)
}
while !group.isEmpty {
do {
try await group.next()
} catch is CancellationError {
// continue
} catch {
group.cancelAll()
throw error
}
}
}
if let iconPath = product.iconPath {
group.addTask {
try await packFileToRoot(srcName: iconPath)
}
}
group.addTask {
try await packFile(srcName: product.targetName, dstName: product.product)
}
group.addTask {
var info = product.infoPlist
if product.type == .application {
info["UIRequiredDeviceCapabilities"] = ["arm64"]
info["LSRequiresIPhoneOS"] = true
info["CFBundleSupportedPlatforms"] = ["iPhoneOS"]
}
if let iconPath = product.iconPath {
let iconName = URL(fileURLWithPath: iconPath).deletingPathExtension().lastPathComponent
info["CFBundleIconFile"] = iconName
}
let infoPath = outputURL.appendingPathComponent("Info.plist")
let encodedPlist = try PropertyListSerialization.data(
fromPropertyList: info,
format: .xml,
options: 0
)
try encodedPlist.write(to: infoPath)
}
}
}
extension Plan.Product {
fileprivate var linkerSettings: String {
switch self.type {
case .application: """
[
.unsafeFlags([
"-Xlinker", "-rpath", "-Xlinker", "@executable_path/Frameworks",
]),
]
"""
case .appExtension: """
[
// Link to Foundation framework which implements the _NSExtensionMain entrypoint
.linkedFramework("Foundation"),
.unsafeFlags([
// Set the entry point to Foundation`_NSExtensionMain
"-Xlinker", "-e", "-Xlinker", "_NSExtensionMain",
// Include frameworks that the host app may use
"-Xlinker", "-rpath", "-Xlinker", "@executable_path/../../Frameworks",
// ...as well as our own
"-Xlinker", "-rpath", "-Xlinker", "@executable_path/Frameworks",
]),
]
"""
}
let dest = URL(fileURLWithPath: "xtool")
.appendingPathComponent(output.url.lastPathComponent)
try? FileManager.default.removeItem(at: dest)
try output.persist(at: dest)
return dest
}
}
+57 -202
View File
@@ -1,5 +1,4 @@
import Foundation
import XUtils
public struct Planner: Sendable {
public var buildSettings: BuildSettings
@@ -19,12 +18,14 @@ public struct Planner: Sendable {
return decoder
}()
// anything older than this requires bundling the stdlib which
// is doable but probably not worth the effort
private static let minSupportedIOSVersion = "13.0"
public func createPlan() async throws -> Plan {
// TODO: cache plan using (Package.swift+Package.resolved) as the key?
private func buildGraph() async throws -> PackageGraph {
let dependencyRoot = try await dumpDependencies()
let dependencyData = try await _dumpAction(
arguments: ["show-dependencies", "--format", "json"],
path: buildSettings.packagePath
)
let dependencyRoot = try Self.decoder.decode(PackageDependency.self, from: dependencyData)
let packages = try await withThrowingTaskGroup(
of: (PackageDependency, PackageDump).self,
@@ -63,74 +64,18 @@ public struct Planner: Sendable {
}
let rootPackage = packages[dependencyRoot.identity]!
let deploymentTarget = rootPackage.platforms?.first { $0.name == "ios" }?.version ?? "13.0"
return PackageGraph(
root: rootPackage,
packages: packages,
packagesByProductName: packagesByProductName
)
}
let libraries = rootPackage.products?.filter { $0.type == .autoLibrary } ?? []
public func createPlan() async throws -> Plan {
// TODO: cache plan using (Package.swift+Package.resolved) as the key?
let graph = try await buildGraph()
let app = try await product(
from: graph,
matching: schema.product,
type: .application,
plist: schema.infoPath,
idSpecifier: schema.idSpecifier,
iconPath: schema.iconPath,
rootResources: schema.resources,
entitlementsPath: schema.entitlementsPath
)
let extensionProducts: [Plan.Product]
if let extensions = schema.extensions, !extensions.isEmpty {
extensionProducts = try await withThrowingTaskGroup(of: Plan.Product.self) { group in
for ext in extensions {
group.addTask {
try await product(
from: graph,
matching: ext.product,
type: .appExtension,
plist: ext.infoPath,
idSpecifier: ext.bundleID.flatMap(PackSchema.IDSpecifier.bundleID) ?? .orgID(app.bundleID),
iconPath: nil,
rootResources: ext.resources,
entitlementsPath: ext.entitlementsPath
)
}
}
return try await group.reduce(into: []) { $0.append($1) }
}
} else {
extensionProducts = []
}
return Plan(app: app, extensions: extensionProducts)
}
// swiftlint:disable cyclomatic_complexity function_parameter_count
private func product(
from graph: PackageGraph,
matching name: String?,
type: Plan.ProductType,
plist: String?,
idSpecifier: PackSchema.IDSpecifier,
iconPath: String?,
rootResources: [String]?,
entitlementsPath: String?
) async throws -> Plan.Product {
let library = try selectLibrary(
from: graph.root.products?.filter { $0.type == .autoLibrary } ?? [],
matching: name
from: libraries,
matching: schema.base.product
)
var resources: [Plan.Resource] = []
var resources: [Resource] = []
var visited: Set<String> = []
var targets = library.targets.map { (graph.root, $0) }
var targets = library.targets.map { (rootPackage, $0) }
while let (targetPackage, targetName) = targets.popLast() {
guard let target = targetPackage.targets?.first(where: { $0.name == targetName }) else {
throw StringError("Could not find target '\(targetName)' in package '\(targetPackage.name)'")
@@ -146,7 +91,15 @@ public struct Planner: Sendable {
targets.append((targetPackage, targetName))
}
for productName in (target.productDependencies ?? []) {
let (package, product) = try graph.product(name: productName)
guard let packageID = packagesByProductName[productName] else {
throw StringError("Could not find package containing product '\(productName)'")
}
guard let package = packages[packageID] else {
throw StringError("Could not find package by id '\(packageID)'")
}
guard let product = package.products?.first(where: { $0.name == productName }) else {
throw StringError("Could not find product '\(productName)' in package '\(packageID)'")
}
if product.type == .dynamicLibrary {
resources.append(.library(name: productName))
}
@@ -154,44 +107,37 @@ public struct Planner: Sendable {
}
}
if let rootResources {
if let rootResources = schema.base.resources {
resources += rootResources.map { .root(source: $0) }
}
let bundleID = idSpecifier.formBundleID(product: library.name)
let deploymentTarget = graph.root.platforms?.first { $0.name == "ios" }?.version
?? Self.minSupportedIOSVersion
let bundleID = schema.idSpecifier.formBundleID(product: library.name)
var infoPlist: [String: Sendable] = [
"CFBundleInfoDictionaryVersion": "6.0",
"UIRequiredDeviceCapabilities": ["arm64"],
"LSRequiresIPhoneOS": true,
"CFBundleSupportedPlatforms": ["iPhoneOS"],
"CFBundlePackageType": "APPL",
"UIDeviceFamily": [1, 2],
"CFBundleDevelopmentRegion": "en",
"UISupportedInterfaceOrientations": ["UIInterfaceOrientationPortrait"],
"UISupportedInterfaceOrientations~ipad": [
"UIInterfaceOrientationPortrait",
"UIInterfaceOrientationPortraitUpsideDown",
"UIInterfaceOrientationLandscapeLeft",
"UIInterfaceOrientationLandscapeRight"
],
"UILaunchScreen": [:] as [String: Sendable],
"CFBundleVersion": "1",
"CFBundleShortVersionString": "1.0.0",
"MinimumOSVersion": deploymentTarget,
"CFBundleIdentifier": bundleID,
"CFBundleName": library.name,
"CFBundleExecutable": library.name,
"CFBundleDisplayName": library.name,
"CFBundlePackageType": type.fourCharCode,
"CFBundleName": "\(library.name)",
"CFBundleExecutable": "\(library.name)",
]
switch type {
case .application:
infoPlist["UIDeviceFamily"] = [1, 2]
infoPlist["UISupportedInterfaceOrientations"] = ["UIInterfaceOrientationPortrait"]
infoPlist["UISupportedInterfaceOrientations~ipad"] = [
"UIInterfaceOrientationPortrait",
"UIInterfaceOrientationPortraitUpsideDown",
"UIInterfaceOrientationLandscapeLeft",
"UIInterfaceOrientationLandscapeRight",
]
infoPlist["UILaunchScreen"] = [:] as [String: Sendable]
case .appExtension:
// Should set default parameters?
infoPlist["NSExtension"] = [:] as [String: Sendable]
}
if let plist {
if let plist = self.schema.base.infoPath {
let data = try await Data(reading: URL(fileURLWithPath: plist))
let info = try PropertyListSerialization.propertyList(from: data, format: nil)
if let info = info as? [String: Sendable] {
@@ -201,45 +147,20 @@ public struct Planner: Sendable {
}
}
return Plan.Product(
type: type,
return Plan(
product: library.name,
deploymentTarget: deploymentTarget,
bundleID: bundleID,
infoPlist: infoPlist,
resources: resources,
iconPath: iconPath,
entitlementsPath: entitlementsPath
)
}
private func dumpDependencies() async throws -> PackageDependency {
let tempDir = try TemporaryDirectory(name: "xtool-dump")
let tempFileURL = tempDir.url.appendingPathComponent("dump.json")
// SwiftPM sometimes prints extraneous data to stdout, so ask
// it to write the JSON to a temp file instead. See:
// https://github.com/xtool-org/xtool/pull/97#discussion_r2203618825
_ = try await _dumpAction(
arguments: ["-q", "show-dependencies", "--format", "json", "-o", tempFileURL.path],
path: buildSettings.packagePath
)
return try Self.decoder.decode(
PackageDependency.self,
from: Data(contentsOf: tempFileURL)
iconPath: self.schema.base.iconPath
)
}
private func dumpPackage(at path: String) async throws -> PackageDump {
let data = try await _dumpAction(arguments: ["-q", "describe", "--type", "json"], path: path)
let data = try await _dumpAction(arguments: ["describe", "--type", "json"], path: path)
try Task.checkCancellation()
// As in dumpDependencies, we may end up with extraneous data, but `describe`
// doesn't have a `-o` flag for a clean workaround. Resort to a heuristic,
// looking for the opening brace.
let fromBrace = data.drop(while: { $0 != Character("{").asciiValue })
return try Self.decoder.decode(PackageDump.self, from: fromBrace)
return try Self.decoder.decode(PackageDump.self, from: data)
}
private func _dumpAction(arguments: [String], path: String) async throws -> Data {
@@ -290,66 +211,19 @@ public struct Planner: Sendable {
}
public struct Plan: Sendable {
public var app: Product
public var extensions: [Product]
public var product: String
public var deploymentTarget: String
public var bundleID: String
public var infoPlist: [String: any Sendable]
public var resources: [Resource]
public var iconPath: String?
}
public var allProducts: [Product] {
[app] + extensions
}
public enum Resource: Codable, Sendable, Hashable {
case bundle(package: String, target: String)
case binaryTarget(name: String)
case library(name: String)
case root(source: String)
}
public struct Product: Sendable {
public var type: ProductType
public var product: String
public var deploymentTarget: String
public var bundleID: String
public var infoPlist: [String: any Sendable]
public var resources: [Resource]
public var iconPath: String?
public var entitlementsPath: String?
public var targetName: String {
"\(self.product)-\(self.type.targetSuffix)"
}
public func directory(inApp baseDir: URL) -> URL {
switch type {
case .application:
baseDir
.appendingPathComponent(".", isDirectory: true)
case .appExtension:
baseDir
.appendingPathComponent("PlugIns", isDirectory: true)
.appendingPathComponent(product, isDirectory: true)
.appendingPathExtension("appex")
}
}
}
public enum ProductType: Sendable {
case application
case appExtension
fileprivate var targetSuffix: String {
switch self {
case .application: "App"
case .appExtension: "Extension"
}
}
fileprivate var fourCharCode: String {
switch self {
case .application: "APPL"
case .appExtension: "XPC!"
}
}
}
public enum Resource: Codable, Sendable {
case bundle(package: String, target: String)
case binaryTarget(name: String)
case library(name: String)
case root(source: String)
}
private struct PackageDependency: Decodable {
@@ -425,22 +299,3 @@ private struct PackageDump: Decodable {
let targets: [Target]?
let platforms: [Platform]?
}
private struct PackageGraph {
let root: PackageDump
let packages: [String: PackageDump]
let packagesByProductName: [String: String]
func product(name productName: String) throws -> (PackageDump, PackageDump.Product) {
guard let packageID = packagesByProductName[productName] else {
throw StringError("Could not find package containing product '\(productName)'")
}
guard let package = packages[packageID] else {
throw StringError("Could not find package by id '\(packageID)'")
}
guard let product = package.products?.first(where: { $0.name == productName }) else {
throw StringError("Could not find product '\(productName)' in package '\(packageID)'")
}
return (package, product)
}
}
+58 -77
View File
@@ -13,93 +13,62 @@ public struct XcodePacker {
self.plan = plan
}
// swiftlint:disable:next function_body_length
public func createProject() async throws -> URL {
let targetName = "\(plan.product)-App"
let xtoolDir: Path = "xtool"
let projectDir: Path = xtoolDir + ".xtool-tmp"
try? xtoolDir.delete()
try projectDir.mkpath()
let infoPath = projectDir + "Info.plist"
var plist = plan.infoPlist
let families = (plist.removeValue(forKey: "UIDeviceFamily") as? [Int]) ?? [1, 2]
plist["CFBundleExecutable"] = targetName
plist["CFBundleName"] = targetName
plist["CFBundleDisplayName"] = plan.product
let encodedPlist = try PropertyListSerialization.data(fromPropertyList: plist, format: .xml, options: 0)
try infoPath.write(encodedPlist)
let emptyFile = projectDir + "empty.c"
try emptyFile.write(Data("// leave this file empty".utf8))
let fromProjectToRoot = try Path(".").relativePath(from: projectDir)
guard let deploymentTarget = Version(tolerant: plan.app.deploymentTarget) else {
throw StringError("Could not parse deployment target '\(plan.app.deploymentTarget)'")
}
let emptyText = Data("""
// leave this file empty
""".utf8)
let targets = try plan.allProducts.map { product in
let productDir = projectDir + product.product
try productDir.mkpath()
let emptyFile = productDir + "empty.c"
try emptyFile.write(emptyText)
let infoPath = productDir + "Info.plist"
var plist = product.infoPlist
let families = (plist.removeValue(forKey: "UIDeviceFamily") as? [Int]) ?? [1, 2]
plist["CFBundleExecutable"] = product.targetName
plist["CFBundleName"] = product.targetName
plist["CFBundleDisplayName"] = product.product
let encodedPlist = try PropertyListSerialization.data(fromPropertyList: plist, format: .xml, options: 0)
try infoPath.write(encodedPlist)
var buildSettings: [String: BuildSetting] = [
"PRODUCT_BUNDLE_IDENTIFIER": .string(product.bundleID),
"TARGETED_DEVICE_FAMILY": .string(families.map { "\($0)" }.joined(separator: ",")),
]
if product.type == .appExtension {
buildSettings["APPLICATION_EXTENSION_API_ONLY"] = true
}
if let entitlementsPath = product.entitlementsPath {
buildSettings["CODE_SIGN_ENTITLEMENTS"] = .string((fromProjectToRoot + Path(entitlementsPath)).string)
}
let additionalDependencies: [Dependency] = if product.type == .application {
plan.extensions.map {
Dependency(
type: .target,
reference: $0.targetName
)
}
} else {
[]
}
return Target(
name: product.targetName,
type: product.type == .application ? .application : .appExtension,
platform: .iOS,
deploymentTarget: deploymentTarget,
settings: Settings(buildSettings: buildSettings),
sources: [
TargetSource(
path: try emptyFile.relativePath(from: projectDir).string,
buildPhase: .sources
),
],
dependencies: [
Dependency(
type: .package(products: [product.product]),
reference: "RootPackage"
),
] + additionalDependencies,
info: Plist(
path: try infoPath.relativePath(from: projectDir).string,
attributes: [:]
)
)
guard let deploymentTarget = Version(tolerant: plan.deploymentTarget) else {
throw StringError("Could not parse deployment target '\(plan.deploymentTarget)'")
}
let project = Project(
name: plan.app.targetName,
targets: targets,
name: plan.product,
targets: [
Target(
name: targetName,
type: .application,
platform: .iOS,
deploymentTarget: deploymentTarget,
settings: Settings(buildSettings: [
"PRODUCT_BUNDLE_IDENTIFIER": plan.bundleID,
"TARGETED_DEVICE_FAMILY": families.map { "\($0)" }.joined(separator: ","),
]),
sources: [
TargetSource(path: (fromProjectToRoot + emptyFile).string),
],
dependencies: [
Dependency(
type: .package(products: [plan.product]),
reference: "RootPackage"
),
],
info: Plist(
path: (fromProjectToRoot + infoPath).string,
attributes: [:]
)
)
],
packages: [
"RootPackage": .local(
path: fromProjectToRoot.string,
@@ -116,8 +85,8 @@ public struct XcodePacker {
// TODO: Handle plan.iconPath
let generator = ProjectGenerator(project: project)
let xcodeproj = projectDir + "\(plan.app.product).xcodeproj"
let xcworkspace = xtoolDir + "\(plan.app.product).xcworkspace"
let xcodeproj = projectDir + "\(plan.product).xcodeproj"
let xcworkspace = xtoolDir + "\(plan.product).xcworkspace"
do {
let current = Path.current
Path.current = xcodeproj.parent()
@@ -130,6 +99,18 @@ public struct XcodePacker {
xcodeProject.pbxproj.delete(object: packageRef)
}
if let emptyFileRef = xcodeProject.pbxproj.fileReferences.first(where: { $0.path == "empty.c" }),
let existingGroup = xcodeProject.pbxproj.groups.first(where: {
$0.children.contains { $0.uuid == emptyFileRef.uuid }
}),
let existingGroupGroup = xcodeProject.pbxproj.groups.first(where: {
$0.children.contains { $0.uuid == existingGroup.uuid }
}) {
existingGroupGroup.children.removeAll(where: { $0.uuid == existingGroup.uuid })
existingGroupGroup.children.insert(emptyFileRef, at: 0)
xcodeProject.pbxproj.delete(object: existingGroup)
}
try xcodeProject.write(path: Path(xcodeproj.lastComponent))
}
@@ -15,14 +15,13 @@ public struct ASCKey: Sendable {
actor ASCJWTGenerator {
// the duration for which we generate JWTs.
// ASC allows a maximum of 20 minutes. We use
// 15 minutes to account for clock drift.
private static let ttl: TimeInterval = 60 * 15
// ASC allows a maximum of 20 minutes.
private static let ttl: TimeInterval = 60 * 20
// the minimum remaining ttl for us to consider reusing a previous key.
// that is, we reuse the last JWT if it has at least [threshold] seconds
// left before it expires.
private static let tolerance: TimeInterval = 60 * 2
private static let tolerance: TimeInterval = 60
private static let encoder: JSONEncoder = {
let encoder = JSONEncoder()
@@ -13,6 +13,7 @@ public struct DeveloperServicesAddAppOperation: DeveloperServicesOperation {
public enum Error: LocalizedError {
case invalidApp(URL)
case teamNotFound(DeveloperServicesTeam.ID)
public var errorDescription: String? {
switch self {
@@ -24,6 +25,16 @@ public struct DeveloperServicesAddAppOperation: DeveloperServicesOperation {
), $0
)
}
case .teamNotFound(let id):
return id.rawValue.withCString {
String.localizedStringWithFormat(
NSLocalizedString(
"add_app_operation.error.team_not_found",
value: "A team with the ID '%s' could not be found. Please select another team.",
comment: ""
), $0
)
}
}
}
}
@@ -41,22 +52,14 @@ public struct DeveloperServicesAddAppOperation: DeveloperServicesOperation {
private func upsertApp(
bundleID: String,
entitlements: Entitlements,
isFreeTeam: Bool
isFreeTeam: Bool,
appIDs: [String: Components.Schemas.BundleId]
) async throws -> Components.Schemas.BundleId {
let newBundleID = ProvisioningIdentifiers.identifier(fromSanitized: bundleID, context: self.context)
let existing = try await context.developerAPIClient
.bundleIdsGetCollection(query: .init(
filter_lbrack_identifier_rbrack_: [bundleID]
))
.ok.body.json.data
// filter[identifier] is a prefix filter so we need to manually upgrade to equality
.first(where: { $0.attributes?.identifier == newBundleID })
let appID: Components.Schemas.BundleId
if let existing {
if let existing = appIDs[bundleID] {
appID = existing
} else {
let newBundleID = ProvisioningIdentifiers.identifier(fromSanitized: bundleID, context: self.context)
let name = ProvisioningIdentifiers.appName(fromSanitized: bundleID)
let createResponse = try await context.developerAPIClient.bundleIdsCreateInstance(
body: .json(
@@ -65,7 +68,7 @@ public struct DeveloperServicesAddAppOperation: DeveloperServicesOperation {
_type: .bundleIds,
attributes: .init(
name: name,
platform: .init(.ios),
platform: .ios,
identifier: newBundleID
)
)
@@ -112,13 +115,9 @@ public struct DeveloperServicesAddAppOperation: DeveloperServicesOperation {
.ok
}
} else {
// DeveloperServices doesn't allow deleting these capabilities
let requiredCapabilities: Set<Components.Schemas.CapabilityType.Value1Payload> = [.inAppPurchase]
if let capType = cap.attributes?.capabilityType?.value1, !requiredCapabilities.contains(capType) {
_ = try await context.developerAPIClient
.bundleIdCapabilitiesDeleteInstance(path: .init(id: cap.id))
.noContent
}
_ = try await context.developerAPIClient
.bundleIdCapabilitiesDeleteInstance(path: .init(id: cap.id))
.noContent
}
}
for (typ, settings) in wantedCapabilities {
@@ -137,8 +136,8 @@ public struct DeveloperServicesAddAppOperation: DeveloperServicesOperation {
id: appID.id
)
),
// not public but required iff using ds2 API
capability: context.auth.isPublicAPI ? nil : .init(
// not public but required when using ds2 API
capability: .init(
data: .init(
_type: .capabilities,
id: typ
@@ -158,7 +157,8 @@ public struct DeveloperServicesAddAppOperation: DeveloperServicesOperation {
/// that the app has).
private func addApp(
_ app: URL,
isFreeTeam: Bool
isFreeTeam: Bool,
appIDs: [String: Components.Schemas.BundleId]
) async throws -> ProvisioningInfo {
let infoURL = app.appendingPathComponent("Info.plist")
guard let data = try? Data(contentsOf: infoURL),
@@ -172,7 +172,7 @@ public struct DeveloperServicesAddAppOperation: DeveloperServicesOperation {
var entitlements: Entitlements
// if the executable doesn't already have entitlements, that's
// okay. We don't have to throw an error.
if let entitlementsData = try? await context.signer.analyze(executable: executableURL),
if let entitlementsData = try? await context.signerImpl.analyze(executable: executableURL),
let decodedEntitlements = try? PropertyListDecoder().decode(Entitlements.self, from: entitlementsData) {
entitlements = decodedEntitlements
@@ -186,7 +186,7 @@ public struct DeveloperServicesAddAppOperation: DeveloperServicesOperation {
entitlements = try Entitlements(entitlements: [])
}
let appID = try await upsertApp(bundleID: bundleID, entitlements: entitlements, isFreeTeam: isFreeTeam)
let appID = try await upsertApp(bundleID: bundleID, entitlements: entitlements, isFreeTeam: isFreeTeam, appIDs: appIDs)
let newBundleID = appID.attributes!.identifier!
let teamID = try signingInfo.certificate.teamID()
@@ -232,17 +232,42 @@ public struct DeveloperServicesAddAppOperation: DeveloperServicesOperation {
)
}
private func getTeamIsFree() async throws -> Bool {
switch context.auth {
case .appStoreConnect:
return false
case .xcode(let authData):
let client = DeveloperServicesClient(authData: authData)
let request = DeveloperServicesListTeamsRequest()
let teams = try await client.send(request)
guard let team = teams.first(where: { $0.id == authData.teamID })
else { throw Error.teamNotFound(authData.teamID) }
return team.isFree
}
}
// keyed by sanitized bundle ID
private func getCurrentAppIDs() async throws -> [String: Components.Schemas.BundleId] {
let bundleIDs = try await context.developerAPIClient.bundleIdsGetCollection().ok.body.json.data
let keyedIDs = bundleIDs
.compactMap { id -> (String, Components.Schemas.BundleId)? in
guard let bundleID = id.attributes?.identifier else { return nil }
return (ProvisioningIdentifiers.sanitize(identifier: bundleID), id)
}
return Dictionary(keyedIDs, uniquingKeysWith: { $1 })
}
/// Registers the app + its extensions, returning the profile and entitlements of each
public func perform() async throws -> [URL: ProvisioningInfo] {
var apps: [URL] = [root]
for pluginsDir in ["PlugIns", "Extensions"] {
let plugins = root.appendingPathComponent(pluginsDir)
guard plugins.dirExists else { continue }
let plugins = root.appendingPathComponent("PlugIns")
if plugins.dirExists {
apps += plugins.implicitContents.filter { $0.pathExtension.lowercased() == "appex" }
}
let isFreeTeam = try await context.auth.team()?.isFree == true
async let isFreeTeamTask = getTeamIsFree()
async let appIDsTask = getCurrentAppIDs()
let (isFreeTeam, appIDs) = try await (isFreeTeamTask, appIDsTask)
return try await withThrowingTaskGroup(
of: (URL, ProvisioningInfo).self,
@@ -250,7 +275,7 @@ public struct DeveloperServicesAddAppOperation: DeveloperServicesOperation {
) { group in
for app in apps {
group.addTask {
let info = try await addApp(app, isFreeTeam: isFreeTeam)
let info = try await addApp(app, isFreeTeam: isFreeTeam, appIDs: appIDs)
return (app, info)
}
}
@@ -15,21 +15,11 @@ public struct DeveloperServicesCapability: Sendable, Hashable {
public var settings: [Components.Schemas.CapabilitySetting]?
public init(
_ capabilityType: Components.Schemas.CapabilityType.Value1Payload,
_ capabilityType: Components.Schemas.CapabilityType,
isFree: Bool,
settings: [Components.Schemas.CapabilitySetting]? = nil
) {
self.capabilityType = .init(capabilityType)
self.isFree = isFree
self.settings = settings
}
public init(
rawName: String,
isFree: Bool,
settings: [Components.Schemas.CapabilitySetting]? = nil
) {
self.capabilityType = .init(value2: rawName)
self.capabilityType = capabilityType
self.isFree = isFree
self.settings = settings
}
@@ -49,7 +39,7 @@ extension Entitlement {
extension DataProtectionEntitlement: EntitlementWithCapability {
var capability: DeveloperServicesCapability {
let option: Components.Schemas.CapabilityOption.KeyPayload.Value1Payload = switch self {
let option: Components.Schemas.CapabilityOption.KeyPayload = switch self {
case .complete: .completeProtection
case .unlessOpen: .protectedUnlessOpen
case .untilFirstAuth: .protectedUntilFirstUserAuth
@@ -59,8 +49,8 @@ extension DataProtectionEntitlement: EntitlementWithCapability {
isFree: true,
settings: [
.init(
key: .init(.dataProtectionPermissionLevel),
options: [.init(key: .init(option))]
key: .dataProtectionPermissionLevel,
options: [.init(key: option)]
)
]
)
@@ -54,7 +54,7 @@ public struct DeveloperServicesFetchCertificateOperation: DeveloperServicesOpera
_type: .certificates,
attributes: .init(
csrContent: csr.pemString,
certificateType: .init(.development)
certificateType: .development
)
)))
)
@@ -72,21 +72,19 @@ public struct DeveloperServicesFetchCertificateOperation: DeveloperServicesOpera
_ certificates: [DeveloperServicesCertificate],
requireConfirmation: Bool
) async throws -> SigningInfo {
if try await context.auth.team()?.isFree == true {
if !certificates.isEmpty, requireConfirmation {
guard await confirmRevocation(certificates)
else { throw CancellationError() }
}
try await withThrowingTaskGroup(of: Void.self) { group in
for certificate in certificates {
group.addTask {
_ = try await context.developerAPIClient
.certificatesDeleteInstance(path: .init(id: certificate.id))
.noContent
}
if !certificates.isEmpty, requireConfirmation {
guard await confirmRevocation(certificates)
else { throw CancellationError() }
}
try await withThrowingTaskGroup(of: Void.self) { group in
for certificate in certificates {
group.addTask {
_ = try await context.developerAPIClient
.certificatesDeleteInstance(path: .init(id: certificate.id))
.noContent
}
try await group.waitForAll()
}
try await group.waitForAll()
}
let signingInfo = try await createCertificate()
signingInfoManager[self.context.auth.identityID] = signingInfo
@@ -6,58 +6,21 @@ import OpenAPIURLSession
import Dependencies
extension DeveloperAPIClient {
@TaskLocal fileprivate static var cursor: [URLQueryItem] = []
public init(
auth: DeveloperAPIAuthData
) {
@Dependency(\.httpClient) var httpClient
self.init(
// swiftlint:disable:next force_try
serverURL: try! Servers.Server1.url(),
configuration: .init(
dateTranscoder: .iso8601WithFractionalSeconds
),
transport: httpClient.asOpenAPITransport,
middlewares: [
auth.middleware,
LoggingMiddleware(),
auth.middleware
]
)
}
/// Perform a paginated request, starting at the page given by `link`.
///
/// `link` should be a URL that contains a `cursor` query parameter. The
/// cursor will be applied to any requests made inside the closure.
public static func withNextLink<T>(
_ link: String?,
isolation: isolated (any Actor)? = #isolation,
perform action: () async throws -> T
) async throws -> T {
let cursor: [URLQueryItem]
if let link {
guard let components = URLComponents(string: link),
let newOffset = components.queryItems?.first(where: { $0.name == "cursor" }),
let newLimit = components.queryItems?.first(where: { $0.name == "limit" })
else { throw Errors.badNextLink(link) }
// the next value will contain a cursor (offset) *and* a limit even if we didn't
// provide a limit in our initial request. we need to include the limit in subsequent
// requests, otherwise the cursor isn't respected.
cursor = [newOffset, newLimit]
} else {
cursor = []
}
return try await $cursor.withValue(cursor) {
try await action()
}
}
public enum Errors: Error {
case badNextLink(String)
}
}
public enum DeveloperAPIAuthData: Sendable {
@@ -73,13 +36,6 @@ public enum DeveloperAPIAuthData: Sendable {
}
}
public var isPublicAPI: Bool {
switch self {
case .appStoreConnect: true
case .xcode: false
}
}
// A unique ID tied to this token
public var identityID: String {
switch self {
@@ -169,13 +125,9 @@ public struct DeveloperAPIXcodeAuthMiddleware: ClientMiddleware {
let path = request.path ?? "/"
var components = URLComponents(string: path) ?? .init()
var items = components.queryItems ?? []
items.upsertQueryItems(DeveloperAPIClient.cursor + [
components.queryItems = (components.queryItems ?? []) + [
URLQueryItem(name: "teamId", value: authData.teamID.rawValue)
])
components.queryItems = items
]
let query = components.percentEncodedQuery ?? ""
components.query = nil
@@ -261,28 +213,9 @@ public struct DeveloperAPIASCAuthMiddleware: ClientMiddleware {
_ baseURL: URL
) async throws -> (HTTPResponse, HTTPBody?)
) async throws -> (HTTPResponse, HTTPBody?) {
var request = request
let jwt = try await generator.generate()
var request = request
request.headerFields[.authorization] = "Bearer \(jwt)"
let cursor = DeveloperAPIClient.cursor
if !cursor.isEmpty {
var components = URLComponents(string: request.path ?? "") ?? .init()
var items = components.queryItems ?? []
items.upsertQueryItems(cursor)
components.queryItems = items
request.path = components.string
}
return try await next(request, body, baseURL)
}
}
extension [URLQueryItem] {
fileprivate mutating func upsertQueryItems(_ items: [URLQueryItem]) {
let newNames = Set(items.map(\.name))
removeAll { newNames.contains($0.name) }
append(contentsOf: items)
}
}
@@ -34,6 +34,7 @@ public struct DeveloperServicesLoginManager: Sendable {
private func logIn(
withLoginData loginData: GrandSlamLoginData
) async throws -> DeveloperServicesLoginToken {
print("Fetching tokens")
let tokens = try await GrandSlamFetchAppTokensOperation(
client: client,
apps: [.xcode],
@@ -49,6 +50,7 @@ public struct DeveloperServicesLoginManager: Sendable {
password: String,
twoFactorDelegate: TwoFactorAuthDelegate
) async throws -> DeveloperServicesLoginToken {
print("Starting login")
let loginData = try await GrandSlamAuthenticateOperation(
client: client,
// GSA requires Apple IDs in lowercase for SRP
@@ -39,7 +39,7 @@ public struct DeveloperServicesProvisioningOperation: DeveloperServicesOperation
public func perform() async throws -> Response {
progress(0/3)
try await DeveloperServicesAddDeviceOperation(context: context).perform()
_ = try await DeveloperServicesFetchDeviceOperation(context: context).perform()
progress(1/3)
let signingInfo = try await DeveloperServicesFetchCertificateOperation(
@@ -1,59 +0,0 @@
import Foundation
private actor DeveloperServicesTeamFetcher {
static let shared = DeveloperServicesTeamFetcher()
private var cache: [DeveloperServicesTeam.ID: Task<DeveloperServicesTeam, Error>] = [:]
private init() {}
func teams(forXcodeLogin auth: XcodeAuthData) async throws -> DeveloperServicesTeam {
let teamID = auth.teamID
if let cached = cache[teamID] {
return try await cached.value
}
let task = Task {
let client = DeveloperServicesClient(authData: auth)
let teams = try await client.send(DeveloperServicesListTeamsRequest())
guard let team = teams.first(where: { $0.id == teamID })
else { throw Errors.teamNotFound(teamID) }
return team
}
cache[auth.teamID] = task
return try await task.value
}
enum Errors: LocalizedError {
case teamNotFound(DeveloperServicesTeam.ID)
public var errorDescription: String? {
switch self {
case .teamNotFound(let id):
return id.rawValue.withCString {
String.localizedStringWithFormat(
NSLocalizedString(
"add_app_operation.error.team_not_found",
value: "A team with the ID '%s' could not be found. Please select another team.",
comment: ""
), $0
)
}
}
}
}
}
extension XcodeAuthData {
public func team() async throws -> DeveloperServicesTeam {
try await DeveloperServicesTeamFetcher.shared.teams(forXcodeLogin: self)
}
}
extension DeveloperAPIAuthData {
public func team() async throws -> DeveloperServicesTeam? {
switch self {
case .appStoreConnect: nil
case .xcode(let auth): try await auth.team()
}
}
}
@@ -1,36 +0,0 @@
import Foundation
import DeveloperAPI
public struct DeveloperServicesAddDeviceOperation: DeveloperServicesOperation {
public let context: SigningContext
public init(context: SigningContext) {
self.context = context
}
public func perform() async throws {
guard let targetDevice = context.targetDevice else { return }
// try to register the device
let response = try await context.developerAPIClient.devicesCreateInstance(
body: .json(.init(data: .init(
_type: .devices,
attributes: .init(
name: targetDevice.name,
platform: .init(.ios),
udid: targetDevice.udid
)
)))
)
// we get a 409 CONFLICT if the device was already registered.
// handle this by returning gracefully.
if (try? response.conflict) != nil {
return
}
// otherwise, we should get a 201 CREATED to indicate that the device
// was added. any other case is unexpected, and this will throw.
_ = try response.created
}
}
@@ -0,0 +1,39 @@
//
// DeveloperServicesFetchDeviceOperation.swift
// XKit
//
// Created by Kabir Oberai on 13/10/19.
// Copyright © 2019 Kabir Oberai. All rights reserved.
//
import Foundation
import DeveloperAPI
public struct DeveloperServicesFetchDeviceOperation: DeveloperServicesOperation {
public let context: SigningContext
public init(context: SigningContext) {
self.context = context
}
public func perform() async throws -> Components.Schemas.Device {
let devices = try await context.developerAPIClient.devicesGetCollection().ok.body.json.data
if let device = devices.first(where: { $0.attributes?.udid == self.context.udid }) {
return device
}
let response = try await context.developerAPIClient.devicesCreateInstance(
body: .json(.init(data: .init(
_type: .devices,
attributes: .init(
name: self.context.deviceName,
platform: .ios,
udid: self.context.udid
)
)))
)
return try response.created.body.json.data
}
}
@@ -1,78 +0,0 @@
import DeveloperAPI
/// An `AsyncSequence` that unfolds a paginated DeveloperAPI request.
///
/// Some Developer API GET requests are paginated. Each response contains
/// a `links.next` field that points to the next page. This API allows you to
/// consume all pages as an `AsyncSequence`. For example, you can
/// enumerate all devices with
///
/// ```swift
/// let pages = DeveloperAPIPages {
/// try await client.devicesGetCollection().ok.body.json
/// } next: {
/// $0.links.next
/// }
/// for try await page in pages {
/// print(page.data)
/// }
/// ```
public struct DeveloperAPIPages<Page>: AsyncSequence {
// inspired by PagedRequest from
// https://github.com/AvdLee/appstoreconnect-swift-sdk
public var request: @Sendable () async throws -> Page
public var getNext: @Sendable (Page) -> String?
public init(
request: @escaping @Sendable () async throws -> Page,
next getNext: @escaping @Sendable (Page) -> String?
) {
self.request = request
self.getNext = getNext
}
public func makeAsyncIterator() -> AsyncIterator {
AsyncIterator(request: request, getNext: getNext)
}
public struct AsyncIterator: AsyncIteratorProtocol {
fileprivate enum State {
case initial
case hasNext(String)
case end
}
fileprivate let request: @Sendable () async throws -> Page
fileprivate let getNext: @Sendable (Page) -> String?
fileprivate var state: State = .initial
public mutating func next() async throws -> Page? {
guard !Task.isCancelled else { return nil }
let cursor: String?
switch state {
case .initial:
cursor = nil
case .hasNext(let next):
cursor = next
case .end:
return nil
}
let page = try await DeveloperAPIClient.withNextLink(cursor) {
try await request()
}
if let next = getNext(page), next != cursor {
state = .hasNext(next)
} else {
state = .end
}
return page
}
}
}
@@ -1,39 +0,0 @@
import Foundation
import OpenAPIRuntime
import HTTPTypes
struct LoggingMiddleware: ClientMiddleware {
static let regex: NSRegularExpression? = {
guard let pat = ProcessInfo.processInfo.environment["XTL_DEV_LOG"] else { return nil }
return try? NSRegularExpression(pattern: pat)
}()
func intercept(
_ request: HTTPRequest,
body: HTTPBody?,
baseURL: URL,
operationID: String,
next: (HTTPRequest, HTTPBody?, URL) async throws -> (HTTPResponse, HTTPBody?)
) async throws -> (HTTPResponse, HTTPBody?) {
var (response, body) = try await next(request, body, baseURL)
guard Self.regex?.firstMatch(
in: operationID,
range: NSRange(operationID.startIndex..., in: operationID)
) != nil
else { return (response, body) }
print("\n\(operationID) response status -> \(response.status)")
if let unwrapped = body {
let data = try await Data(collecting: unwrapped, upTo: .max)
// body may only be consumable once, replace it with the collected data
body = .init(data)
let text = String(decoding: data, as: UTF8.self)
print("\(operationID) response body -> \(text)")
}
return (response, body)
}
}
@@ -1,31 +0,0 @@
import DeveloperAPI
// syntactic sugar to make it nicer to work with `anyOf:` types
public protocol OpenAPIExtensibleEnum {
associatedtype Value1Payload: RawRepresentable<String>, Codable, Hashable, Sendable, CaseIterable
var value1: Value1Payload? { get set }
var value2: String? { get set }
init(value1: Value1Payload?, value2: String?)
}
extension OpenAPIExtensibleEnum {
public var rawValue: String {
value2!
}
public init(_ value: Value1Payload) {
self.init(value1: value, value2: nil)
}
}
extension Components.Schemas.BundleIdPlatform: OpenAPIExtensibleEnum {}
extension Components.Schemas.CapabilityOption.KeyPayload: OpenAPIExtensibleEnum {}
extension Components.Schemas.CapabilitySetting.KeyPayload: OpenAPIExtensibleEnum {}
extension Components.Schemas.CapabilityType: OpenAPIExtensibleEnum {}
extension Components.Schemas.CertificateType: OpenAPIExtensibleEnum {}
extension Components.Schemas.Device.AttributesPayload.DeviceClassPayload: OpenAPIExtensibleEnum {}
extension Components.Schemas.Device.AttributesPayload.StatusPayload: OpenAPIExtensibleEnum {}
extension Components.Schemas.Profile.AttributesPayload.ProfileStatePayload: OpenAPIExtensibleEnum {}
extension Components.Schemas.Profile.AttributesPayload.ProfileTypePayload: OpenAPIExtensibleEnum {}
extension Components.Schemas.ProfileCreateRequest.DataPayload.AttributesPayload.ProfileTypePayload: OpenAPIExtensibleEnum {}
@@ -71,7 +71,6 @@ public struct DeveloperServicesFetchProfileOperation: DeveloperServicesOperation
let allDevices = try await context.developerAPIClient.devicesGetCollection()
.ok.body.json.data
.filter { $0.attributes?.deviceClass?.value1?.supportsIOSApps == true }
let response = try await context.developerAPIClient.profilesCreateInstance(
body: .json(
@@ -79,8 +78,8 @@ public struct DeveloperServicesFetchProfileOperation: DeveloperServicesOperation
data: .init(
_type: .profiles,
attributes: .init(
name: "XTL profile \(bundleID.id)",
profileType: .init(.iosAppDevelopment)
name: "SC profile \(bundleID.id)",
profileType: .iosAppDevelopment
),
relationships: .init(
bundleId: .init(
@@ -107,12 +106,3 @@ public struct DeveloperServicesFetchProfileOperation: DeveloperServicesOperation
}
}
extension Components.Schemas.Device.AttributesPayload.DeviceClassPayload.Value1Payload {
fileprivate var supportsIOSApps: Bool {
switch self {
case .ipad, .iphone, .ipod: true
default: false
}
}
}
@@ -9,7 +9,7 @@
import Foundation
public struct DeveloperServicesTeam: Decodable, Sendable {
public struct ID: RawRepresentable, Decodable, Sendable, Hashable {
public struct ID: RawRepresentable, Decodable, Sendable {
public let rawValue: String
public init(rawValue: String) { self.rawValue = rawValue }
}
@@ -174,7 +174,7 @@ public struct ADIDataProvider: AnisetteDataProvider {
.acceptLanguage: "en_US",
.init(AnisetteData.localUserIDKey)!: self.localUserID,
]
request.headerFields[.init("X-MMe-Country")!] = Locale.current.region?.identifier
request.headerFields[.init("X-MMe-Country")!] = Locale.current.regionCode
request.headerFields[.init(DeviceInfo.clientInfoKey)!] = try await clientInfo()
request.headerFields[.init(DeviceInfo.deviceIDKey)!] = self.localUserUID.uuidString
@@ -225,11 +225,7 @@ public struct ADIDataProvider: AnisetteDataProvider {
) async throws -> AnisetteData {
let requestTime = Date()
var routingInfo = routingInfo
let (mid, otp) = try await rawProvider.requestOTP(
userID: localUserUID,
routingInfo: &routingInfo,
provisioningInfo: provisioningInfo
)
let (mid, otp) = try await rawProvider.requestOTP(userID: localUserUID, routingInfo: &routingInfo, provisioningInfo: provisioningInfo)
return AnisetteData(
clientTime: requestTime,
routingInfo: routingInfo,
@@ -54,8 +54,7 @@ public struct AnisetteData {
var dictionary: [String: String] {
// GSA doesn't like "en_US@rg=..."; it has to be just "en_US".
let localeIdentifier = if let language = locale.language.languageCode?.identifier,
let region = locale.region?.identifier {
let localeIdentifier = if let language = locale.languageCode, let region = locale.regionCode {
"\(language)_\(region)"
} else {
"en_US"
@@ -56,14 +56,13 @@ extension DeviceInfo {
private static func fetchHardwareModel() -> String? {
var modelSize = 0
guard sysctlbyname("hw.model", nil, &modelSize, nil, 0) == 0,
modelSize > 0 else { return nil }
return String(unsafeUninitializedCapacity: modelSize) { buf in
var len = modelSize
guard sysctlbyname("hw.model", buf.baseAddress, &len, nil, 0) == 0,
len == modelSize else { return 0 }
return len - 1 // exclude NUL
guard sysctlbyname("hw.model", nil, &modelSize, nil, 0) == 0 else { return nil }
guard let rawString = malloc(modelSize) else { return nil }
guard sysctlbyname("hw.model", rawString, &modelSize, nil, 0) == 0 else {
free(rawString)
return nil
}
return String(bytesNoCopy: rawString, length: modelSize - 1, encoding: .utf8, freeWhenDone: true)
}
public static func current() -> DeviceInfo? {
@@ -92,7 +91,7 @@ extension DeviceInfo {
romAddress: "94f6a300e9a0",
mlbSerialNumber: "C02520301W0GF2D1U",
serialNumber: "C02PQKRJG8WP",
modelID: "Mac16,1"
modelID: "MacBookPro11,5"
)
}
}
@@ -17,8 +17,8 @@ public struct DeviceInfo: Codable, Sendable {
public static let xcodeVersion = "14.2 (14C18)"
public struct ClientInfo: Codable {
public static let macOSVersion = "14.3.1"
public static let macOSBuild = "23D60"
public static let macOSVersion = "10.14.6"
public static let macOSBuild = "18G103"
public static let authKitVersion = "1"
public static let akdVersion = "1.0"
@@ -129,15 +129,6 @@ public actor XADIProvider: RawADIProvider {
}
})
let file = adiDirectory.appending(path: "adi.pb")
// adi saves the file as 0o034 (group wx, public r) by default
// which is a... strange choice that prevents us from reading
// or writing by default. Since we're the owner, we can easily
// change this though.
try FileManager.default.setAttributes(
// rw for owner
[.posixPermissions: 0o600],
ofItemAtPath: file.path
)
return try Data(contentsOf: file)
}
}
@@ -153,10 +144,13 @@ public actor XADIProvider: RawADIProvider {
var midLen: UInt32 = 0
var otpBytes: UnsafeMutableRawPointer?
var otpLen: UInt32 = 0
let adiDirectory = directory.appending(path: "adi")
try? FileManager.default.createDirectory(at: adiDirectory, withIntermediateDirectories: true)
let adiFile = adiDirectory.appending(path: "adi.pb")
// this file may be saved as write-protected, but we can still remove it
// and then overwrite it.
try? FileManager.default.removeItem(at: adiFile)
try provisioningInfo.write(to: adiFile)
try check(xadi_OTPRequest(
@@ -111,7 +111,7 @@ struct SRPClient {
let hashedPassword = Data(SHA256.hash(data: Data(password.utf8)))
let pbkdfInput = if isLegacyProtocol {
Data(hashedPassword.map { String(format: "%02hhx", $0) }.joined().utf8)
Data(hashedPassword.map { String(format: "%02hhx", $0) }.joined(separator: "").utf8)
} else {
hashedPassword
}
@@ -45,7 +45,7 @@ actor GrandSlamLookupManager {
.init(AnisetteData.timeZoneKey)!: TimeZone.current.identifier,
.init("X-Apple-I-TimeZone-Offset")!: "\(TimeZone.current.secondsFromGMT())"
]
request.headerFields[.init("X-MMe-Country")!] = Locale.current.region?.identifier
request.headerFields[.init("X-MMe-Country")!] = Locale.current.regionCode
let (_, body) = try await httpClient.makeRequest(request)
@@ -15,7 +15,7 @@ struct GrandSlamLoginData: Decodable {
let cookie: Data
var identityToken: String {
Data("\(adsid):\(idmsToken)".utf8).base64EncodedString()
"\(adsid):\(idmsToken)".data(using: .utf8)!.base64EncodedString()
}
private enum CodingKeys: String, CodingKey {
@@ -65,6 +65,8 @@ struct GrandSlamAuthenticateOperation {
}
private func authenticate(isRetry: Bool) async throws -> GrandSlamLoginData {
print("Doing SRP stuff")
var srpClient = SRPClient()
srpClient.add(string: GrandSlamAuthInitRequest.protocols.joined(separator: ","))
@@ -116,6 +118,8 @@ struct GrandSlamAuthenticateOperation {
)
}
print("Got loginData")
return loginData
}
@@ -64,6 +64,7 @@ struct GrandSlamFetchAppTokensOperation {
func perform() async throws -> [AppTokenKey: Token] {
let checksum = AppTokens.checksum(withSK: loginData.sk, adsid: loginData.adsid, apps: apps.map { $0.rawValue })
print("Got checksum")
let appTokensRequest = GrandSlamAppTokensRequest(
username: loginData.adsid,
apps: apps,
@@ -71,7 +72,9 @@ struct GrandSlamFetchAppTokensOperation {
idmsToken: loginData.idmsToken,
checksum: checksum
)
print("Sending tokens req")
let response = try await client.send(appTokensRequest)
print("Handling tokens resp")
return try await self.handle(response: response)
}
@@ -46,3 +46,4 @@ struct GrandSlamValidateSMSRequest: GrandSlamTwoFactorRequest {
])
}
}
@@ -24,11 +24,10 @@ extension HTTPClientDependencyKey: DependencyKey {
let appleRootCA = try! NIOSSLCertificate(bytes: Array(appleRootPEM.utf8), format: .pem)
var tlsConfiguration: TLSConfiguration = .makeClientConfiguration()
tlsConfiguration.additionalTrustRoots = [.certificates([appleRootCA])]
var config = HTTPClient.Configuration(
let config = HTTPClient.Configuration(
tlsConfiguration: tlsConfiguration,
decompression: .enabled(limit: .none)
)
config.timeout.connect = .seconds(60)
return HTTPClient(configuration: config)
}()
}
@@ -75,6 +75,11 @@ public actor AppInstaller {
}
}
// serial queue
private let installQueue = DispatchQueue(
label: "com.kabiroberai.xtool.install-queue"
)
public let ipa: URL
public let udid: String
public let connectionPreferences: Connection.Preferences
+3 -11
View File
@@ -72,7 +72,7 @@ public actor Connection {
private static let pool = WeakPool<ConnectionDescriptor, Connection, Error>()
private var handle: AnyObject?
private let heartbeatHandler: HeartbeatHandler?
private let heartbeatHandler: HeartbeatHandler
private let udid: String
public let device: Device
public let client: LockdownClient
@@ -101,12 +101,8 @@ public actor Connection {
client = try LockdownClient(device: device, label: Self.label, performHandshake: true)
#if os(iOS)
progress(3/4)
heartbeatHandler = try await HeartbeatHandler(device: device, client: client)
#else
heartbeatHandler = nil
#endif
progress(4/4)
}
@@ -126,7 +122,7 @@ public actor Connection {
}
deinit {
heartbeatHandler?.stop()
heartbeatHandler.stop()
// we could nil out connections[udid] here but that might lead to
// weird race conditions against Connection.connection that seem
// like a nightmare to diagnose, and storing an empty box for a
@@ -139,11 +135,7 @@ public actor Connection {
}
#if compiler(<6.2)
private typealias SendableMetatype = Any
#endif
private actor WeakPool<Key: Hashable & SendableMetatype, Value: AnyObject & Sendable, Failure: Error> {
private actor WeakPool<Key: Hashable, Value: AnyObject & Sendable, Failure: Error> {
init() {}
private var pendingValues: [Key: Task<Result<Value, Failure>, Never>] = [:]
@@ -10,7 +10,7 @@ import Foundation
import SwiftyMobileDevice
import ConcurrencyExtras
public actor HeartbeatHandler {
public actor HeartbeatHandler: Sendable {
private struct Error: Swift.Error {}
private struct ReceivedPacket: Decodable {
+1 -1
View File
@@ -15,7 +15,7 @@ public final class IPAUploader: Sendable {
case unexpectedSymlink(at: URL)
}
private static let packagePath = URL(fileURLWithPath: "/PublicStaging")
private static let packagePath = URL(fileURLWithPath: "PublicStaging")
private static let bufferSize = 1 << 20 // 1 MB
public final class UploadedIPA: Sendable {
@@ -2,7 +2,6 @@ import Foundation
import SwiftyMobileDevice
import ConcurrencyExtras
import Dependencies
import XUtils
extension LockdownClient {
static let installerLabel = "xtool"
@@ -45,13 +44,19 @@ public actor IntegratedInstaller {
case unlockDevice
}
let udid: String
let lookupMode: LookupMode
let auth: DeveloperAPIAuthData
let configureDevice: Bool
public weak var delegate: IntegratedInstallerDelegate?
@Dependency(\.zipCompressor) private var compressor
private var appInstaller: AppInstaller?
private let tempDir = FileManager.default.temporaryDirectoryShim
.appendingPathComponent("com.kabiroberai.xtool.Staging")
private var stage: String?
private nonisolated let updateTask = LockIsolated<Task<Void, Never>?>(nil)
@@ -99,10 +104,16 @@ public actor IntegratedInstaller {
}
public init(
udid: String,
lookupMode: LookupMode,
auth: DeveloperAPIAuthData,
configureDevice: Bool,
delegate: IntegratedInstallerDelegate
) {
self.udid = udid
self.lookupMode = lookupMode
self.auth = auth
self.configureDevice = configureDevice
self.delegate = delegate
}
@@ -135,7 +146,7 @@ public actor IntegratedInstaller {
}
}
private func fetchPairingKeys(with lockdownClient: LockdownClient, udid: String) async throws -> Data {
private func fetchPairingKeys(with lockdownClient: LockdownClient) async throws -> Data {
try lockdownClient.setValue(udid, forDomain: "com.apple.mobile.wireless_lockdown", key: "WirelessBuddyID")
try lockdownClient.setValue(true, forDomain: "com.apple.mobile.wireless_lockdown", key: "EnableWifiConnections")
@@ -192,17 +203,15 @@ public actor IntegratedInstaller {
}
@discardableResult
public func install(
app: URL,
udid: String,
lookupMode: LookupMode,
configureDevice: Bool,
) async throws -> String {
public func install(app: URL) async throws -> String {
try await self.updateStage(to: "Unpacking app", initialProgress: nil)
let _tempDir = try TemporaryDirectory(name: "staging")
let tempDir = _tempDir.url
defer { withExtendedLifetime(_tempDir) {} }
if FileManager.default.fileExists(atPath: tempDir.path) {
try? FileManager.default.removeItem(at: tempDir)
}
try FileManager.default.createDirectory(at: tempDir, withIntermediateDirectories: true)
defer { try? FileManager.default.removeItem(at: tempDir) }
switch app.pathExtension {
case "ipa":
@@ -226,11 +235,13 @@ public actor IntegratedInstaller {
try await self.updateProgress(to: 1)
let payload = tempDir.appendingPathComponent("Payload")
let payload = self.tempDir.appendingPathComponent("Payload")
guard let appDir = payload.implicitContents.first(where: { $0.pathExtension == "app" })
else { throw Error.appExtractionFailed }
try await updateStage(to: "Preparing device")
try await updateStage(to: "Logging in")
try await self.updateStage(to: "Preparing device")
// TODO: Maybe use `Connection` here instead of creating the lockdown
// client manually?
@@ -250,7 +261,7 @@ public actor IntegratedInstaller {
let deviceName = try lockdownClient.deviceName()
let pairingKeys: Data? = if configureDevice {
try await fetchPairingKeys(with: lockdownClient, udid: udid)
try await fetchPairingKeys(with: lockdownClient)
} else {
nil
}
@@ -258,15 +269,37 @@ public actor IntegratedInstaller {
try await updateProgress(to: 1)
let bundleID = try await signInPlace(
let context = try SigningContext(
udid: udid,
deviceName: deviceName,
auth: auth
)
let signer = Signer(context: context) { certs in
await self.delegate?.confirmRevocation(of: certs) ?? false
}
let bundleID = try await signer.sign(
app: appDir,
targetDevice: .init(udid: udid, name: deviceName),
status: { @Sendable status in
self.queueUpdateTask {
$0.updateStageIgnoringCancellation(to: status)
}
},
progress: { progress in
self.queueUpdateTask {
$0.updateProgressIgnoringCancellation(to: progress)
}
},
didProvision: { @Sendable [self] in
// TODO: reintroduce Superconfig
_ = self
}
)
try await self.updateStage(to: "Packaging", initialProgress: nil)
let ipa = try await compressor.compress(
directory: payload,
directory: appDir.deletingLastPathComponent(),
progress: { progress in
self.queueUpdateTask {
$0.updateProgressIgnoringCancellation(to: progress)
@@ -289,39 +322,6 @@ public actor IntegratedInstaller {
return bundleID
}
@discardableResult
public func signInPlace(
app: URL,
targetDevice: SigningContext.TargetDevice? = nil,
) async throws -> String {
let context = try SigningContext(
auth: auth,
targetDevice: targetDevice,
)
let signer = AutoSigner(context: context) { certs in
await self.delegate?.confirmRevocation(of: certs) ?? false
}
return try await signer.sign(
app: app,
status: { @Sendable status in
self.queueUpdateTask {
$0.updateStageIgnoringCancellation(to: status)
}
},
progress: { progress in
self.queueUpdateTask {
$0.updateProgressIgnoringCancellation(to: progress)
}
},
didProvision: { @Sendable [self] in
// TODO: reintroduce Superconfig
_ = self
}
)
}
}
#endif
@@ -33,6 +33,7 @@ extension EntitlementContainer {
public struct ApplicationIdentifierEntitlement: Entitlement, RawRepresentable {
public static let identifier = "application-identifier"
public static let isFree = true
public var rawValue: String
public init(rawValue: String) { self.rawValue = rawValue }
@@ -40,6 +41,7 @@ public struct ApplicationIdentifierEntitlement: Entitlement, RawRepresentable {
public struct TeamIdentifierEntitlement: Entitlement, RawRepresentable {
public static let identifier = "com.apple.developer.team-identifier"
public static let isFree = true
public var rawValue: String
public init(rawValue: String) { self.rawValue = rawValue }
@@ -47,6 +49,7 @@ public struct TeamIdentifierEntitlement: Entitlement, RawRepresentable {
public struct KeychainAccessGroupsEntitlement: Entitlement, RawRepresentable {
public static let identifier = "keychain-access-groups"
public static let isFree = true
public var rawValue: [String]
public init(rawValue: [String]) { self.rawValue = rawValue }
@@ -63,6 +66,10 @@ public struct KeychainAccessGroupsEntitlement: Entitlement, RawRepresentable {
public struct AppGroupEntitlement: Entitlement, RawRepresentable {
public static let identifier = "com.apple.security.application-groups"
// FIXME: Enable app groups on free accounts
// but first we need to fix the bug where it only assigns one
// app group even if the ents say there are multiple
public static let isFree = false
public var rawValue: [DeveloperServicesAppGroup.GroupID]
public init(rawValue: [DeveloperServicesAppGroup.GroupID]) { self.rawValue = rawValue }
@@ -78,6 +85,7 @@ public struct AppGroupEntitlement: Entitlement, RawRepresentable {
public struct GetTaskAllowEntitlement: Entitlement, RawRepresentable {
public static let identifier = "get-task-allow"
public static let isFree = true
public var rawValue: Bool
public init(rawValue: Bool) { self.rawValue = rawValue }
@@ -85,6 +93,7 @@ public struct GetTaskAllowEntitlement: Entitlement, RawRepresentable {
public struct AssociatedDomainsEntitlement: Entitlement, RawRepresentable {
public static let identifier = "com.apple.developer.associated-domains"
public static let isFree = false
public var rawValue: [String]
public init(rawValue: [String]) { self.rawValue = rawValue }
@@ -100,6 +109,7 @@ public struct AssociatedDomainsEntitlement: Entitlement, RawRepresentable {
public enum APSEnvironmentEntitlement: String, Entitlement {
public static let identifier = "aps-environment"
public static let isFree = false
case development
case production
@@ -107,6 +117,7 @@ public enum APSEnvironmentEntitlement: String, Entitlement {
public enum DataProtectionEntitlement: String, Entitlement {
public static let identifier = "com.apple.developer.default-data-protection"
public static let isFree = true
case complete = "NSFileProtectionComplete"
case unlessOpen = "NSFileProtectionCompleteUnlessOpen"
@@ -115,6 +126,7 @@ public enum DataProtectionEntitlement: String, Entitlement {
public struct NetworkExtensionEntitlement: Entitlement, RawRepresentable {
public static let identifier = "com.apple.developer.networking.networkextension"
public static let isFree = false
public var rawValue: Bool
public init(rawValue: Bool) { self.rawValue = rawValue }
@@ -122,6 +134,7 @@ public struct NetworkExtensionEntitlement: Entitlement, RawRepresentable {
public struct MultipathEntitlement: Entitlement, RawRepresentable {
public static let identifier = "com.apple.developer.networking.multipath"
public static let isFree = false
public var rawValue: Bool
public init(rawValue: Bool) { self.rawValue = rawValue }
@@ -129,6 +142,7 @@ public struct MultipathEntitlement: Entitlement, RawRepresentable {
public struct VPNConfigurationEntitlement: Entitlement, RawRepresentable {
public static let identifier = "com.apple.networking.vpn.configuration"
public static let isFree = false
public var rawValue: Bool
public init(rawValue: Bool) { self.rawValue = rawValue }
@@ -136,6 +150,7 @@ public struct VPNConfigurationEntitlement: Entitlement, RawRepresentable {
public struct SiriKitEntitlement: Entitlement, RawRepresentable {
public static let identifier = "com.apple.developer.siri"
public static let isFree = false
public var rawValue: Bool
public init(rawValue: Bool) { self.rawValue = rawValue }
@@ -143,6 +158,7 @@ public struct SiriKitEntitlement: Entitlement, RawRepresentable {
public struct InterAppAudioEntitlement: Entitlement, RawRepresentable {
public static let identifier = "inter-app-audio"
public static let isFree = true
public var rawValue: Bool
public init(rawValue: Bool) { self.rawValue = rawValue }
@@ -150,6 +166,7 @@ public struct InterAppAudioEntitlement: Entitlement, RawRepresentable {
public struct WirelessAccessoryEntitlement: Entitlement, RawRepresentable {
public static let identifier = "com.apple.external-accessory.wireless-configuration"
public static let isFree = true
public var rawValue: Bool
public init(rawValue: Bool) { self.rawValue = rawValue }
@@ -157,6 +174,7 @@ public struct WirelessAccessoryEntitlement: Entitlement, RawRepresentable {
public struct HomeKitEntitlement: Entitlement, RawRepresentable {
public static let identifier = "com.apple.developer.homekit"
public static let isFree = true
public var rawValue: Bool
public init(rawValue: Bool) { self.rawValue = rawValue }
@@ -164,6 +182,7 @@ public struct HomeKitEntitlement: Entitlement, RawRepresentable {
public struct HealthKitEntitlement: Entitlement, RawRepresentable {
public static let identifier = "com.apple.developer.healthkit"
public static let isFree = true
public var rawValue: Bool
public init(rawValue: Bool) { self.rawValue = rawValue }
@@ -1,7 +1,14 @@
//
// Signer.swift
// XKit
//
// Created by Kabir Oberai on 13/10/19.
// Copyright © 2019 Kabir Oberai. All rights reserved.
//
import Foundation
/// Provisions and codesigns.
public struct AutoSigner {
public struct Signer {
public enum Error: LocalizedError {
case noSigners
@@ -85,9 +92,10 @@ public struct AutoSigner {
let entitlements = provisioningDict.mapValues(\.entitlements)
status(NSLocalizedString("signer.signing", value: "Signing", comment: ""))
try await context.signer.sign(
try await context.signerImpl.sign(
app: app,
identity: .real(signingInfo.certificate, signingInfo.privateKey),
certificate: signingInfo.certificate,
privateKey: signingInfo.privateKey,
entitlementMapping: entitlements,
progress: progress
)
+32 -41
View File
@@ -1,10 +1,23 @@
//
// SignerImpl.swift
// XKit
//
// Created by Kabir Oberai on 10/10/19.
// Copyright © 2019 Kabir Oberai. All rights reserved.
//
import Foundation
import CXKit
import SignerSupport
import ConcurrencyExtras
/// a wrapper around `signer_t`
public actor Signer {
/// a wrapper around signer_t
public actor SignerImpl {
private static let signingQueue = DispatchQueue(
label: "com.kabiroberai.xtool.signing-queue",
attributes: .concurrent
)
public enum Error: LocalizedError {
case notFound
@@ -31,11 +44,6 @@ public actor Signer {
}
}
public enum Identity {
case real(Certificate, PrivateKey)
case adhoc
}
private let signer: UnsafePointer<signer_t>
public var name: String {
String(cString: signer.pointee.name)
@@ -45,23 +53,24 @@ public actor Signer {
self.signer = signer.value
}
public static func all() -> some Collection<Signer> {
public static func all() -> some Collection<SignerImpl> {
var list = get_signers()
var arr: [Signer] = []
var arr: [SignerImpl] = []
while let curr = list {
arr.append(Signer(signer: UncheckedSendable(curr)))
arr.append(SignerImpl(signer: UncheckedSendable(curr)))
list = curr.pointee.next
}
return arr
}
public static func first() throws -> Signer {
public static func first() throws -> SignerImpl {
try all().first.orThrow(Error.notFound)
}
private func _sign(
app: URL,
identity: Identity,
certificate: Certificate,
privateKey: PrivateKey,
entitlementMapping: [URL: Entitlements],
progress: @escaping (Double?) -> Void
) throws {
@@ -90,32 +99,14 @@ public actor Signer {
}
let sendableProgress = UncheckedSendable(progress)
let sendableEntsArray = UncheckedSendable(entsArray)
let certificateData: Data
let privateKeyData: Data
let lengthOverride: Int?
switch identity {
case .real(let certificate, let privateKey):
certificateData = try certificate.data()
privateKeyData = privateKey.data
lengthOverride = nil
case .adhoc:
// we can't use empty data here because withUnsafeBytes
// might return a bufferpointer with a nil base address,
// but signer.h expects non-null values. The real fix is
// updating xtool-core/SignerSupport/signer.h to annotate
// the pointers as nullable, but alas that requires effort.
certificateData = Data([0])
privateKeyData = Data([0])
lengthOverride = 0
}
try certificateData.withUnsafeBytes { cert in
try privateKeyData.withUnsafeBytes { priv in
try certificate.data().withUnsafeBytes { cert in
let sendableCert = UncheckedSendable(cert)
try privateKey.data.withUnsafeBytes { priv in
var exception: UnsafeMutablePointer<Int8>?
defer { exception.map { free($0) } }
let progress = sendableProgress.value
let cert = sendableCert.value
let entsArray = sendableEntsArray.value
guard let certBase = cert.baseAddress,
@@ -126,10 +117,11 @@ public actor Signer {
defer { box.release() }
guard signer.pointee.sign(
app.path,
certBase, lengthOverride ?? cert.count,
privBase, lengthOverride ?? priv.count,
certBase, cert.count,
privBase, priv.count,
entsArray, entsArray.count,
{
// swiftlint:disable:previous opening_brace
(Unmanaged<AnyObject>
.fromOpaque($0)
.takeUnretainedValue()
@@ -148,16 +140,15 @@ public actor Signer {
public func sign(
app: URL,
identity: Identity,
certificate: Certificate,
privateKey: PrivateKey,
entitlementMapping: [URL: Entitlements],
progress: @escaping (Double?) -> Void
) async throws {
// TODO: #131: update Zupersign to handle multiple entitlements files
// this is a temp hack to just pass along the root app entitlements
let entitlementMapping = entitlementMapping.filter { $0.key.path == app.path }
try self._sign(
app: app,
identity: identity,
certificate: certificate,
privateKey: privateKey,
entitlementMapping: entitlementMapping,
progress: progress
)
+10 -12
View File
@@ -11,27 +11,25 @@ import DeveloperAPI
public struct SigningContext: Sendable {
public struct TargetDevice: Sendable, Hashable {
public var udid: String
public var name: String
}
public var auth: DeveloperAPIAuthData
public var targetDevice: TargetDevice?
public var signer: Signer
public let udid: String
public let deviceName: String
public let auth: DeveloperAPIAuthData
public let signerImpl: SignerImpl
public var developerAPIClient: DeveloperAPIClient {
DeveloperAPIClient(auth: auth)
}
public init(
udid: String,
deviceName: String,
auth: DeveloperAPIAuthData,
targetDevice: TargetDevice? = nil,
signer: Signer? = nil
signerImpl: SignerImpl? = nil
) throws {
self.udid = udid
self.deviceName = deviceName
self.auth = auth
self.targetDevice = targetDevice
self.signer = try signer ?? .first()
self.signerImpl = try signerImpl ?? .first()
}
}
+4 -2
View File
@@ -138,9 +138,11 @@ public struct KeychainStorage: KeyValueStorage {
private func makeQuery(forKey key: String, _ parameters: [CFString: Any]) -> CFDictionary {
var query: [CFString: Any] = [
kSecClass: kSecClassGenericPassword,
kSecAttrAccount: key,
kSecUseDataProtectionKeychain: true,
kSecAttrAccount: key
]
if #available(macOS 10.15, *) {
query[kSecUseDataProtectionKeychain] = true
}
query[kSecAttrService] = service
query.merge(parameters) { _, b in b }
return query as CFDictionary
@@ -21,8 +21,8 @@ extension ProvisioningIdentifiers {
return identifier.split(separator: ".").dropFirst().joined(separator: ".")
}
static func identifier(fromSanitized sanitized: String, context: SigningContext) -> String {
let uuid = context.auth.identityID.split(separator: "-")[0].uppercased()
static func identifier(fromSanitized sanitized: String, context: SigningContext? = nil) -> String {
let uuid = (context?.auth.identityID ?? UUID().uuidString).split(separator: "-")[0].uppercased()
return "\(Self.idPrefix)\(uuid).\(sanitized)"
}
@@ -36,7 +36,7 @@ extension ProvisioningIdentifiers {
return sanitize(identifier: id)
}
static func groupID(fromSanitized sanitized: String, context: SigningContext) -> DeveloperServicesAppGroup.GroupID {
static func groupID(fromSanitized sanitized: String, context: SigningContext? = nil) -> DeveloperServicesAppGroup.GroupID {
.init(rawValue: "\(Self.groupPrefix)\(identifier(fromSanitized: sanitized, context: context))")
}
+1 -1
View File
@@ -47,7 +47,7 @@ private struct UnimplementedSigningInfoManager: SigningInfoManager {
func info(forIdentityID identityID: String) throws -> SigningInfo? {
unimplemented(placeholder: nil)
}
func setInfo(_ info: SigningInfo?, forIdentityID identityID: String) throws {
unimplemented()
}
+6 -1
View File
@@ -21,7 +21,7 @@ struct AuthOperation {
var password: String?
var logoutFromExisting: Bool
var mode: AuthMode?
var mode: AuthMode? = nil
var quiet = false
func run() async throws {
@@ -98,8 +98,13 @@ struct AuthOperation {
twoFactorDelegate: authDelegate
)
print("Got full login token")
let client = DeveloperServicesClient(loginToken: token)
let teams = try await client.send(DeveloperServicesListTeamsRequest())
print("Got teams")
let team = try await Console.choose(
from: teams,
onNoElement: {
+2 -9
View File
@@ -48,15 +48,8 @@ extension AuthToken {
private static let decoder = JSONDecoder()
static func saved() throws -> Self {
guard let token = try savedIfPresent() else {
throw Console.Error("Please log in with `xtool auth` before running this command.")
}
return token
}
static func savedIfPresent() throws -> Self? {
guard let data = try storage.data(forKey: "XTLAuthToken") else {
return nil
throw Console.Error("Please log in with `xtool auth` before running this command.")
}
return try decoder.decode(AuthToken.self, from: data)
}
@@ -70,7 +63,7 @@ extension AuthToken {
try Self.storage.setData(data, forKey: "XTLAuthToken")
}
func authData() -> DeveloperAPIAuthData {
func authData() throws -> DeveloperAPIAuthData {
switch self {
case .appStoreConnect(let data):
return .appStoreConnect(.init(id: data.id, issuerID: data.issuerID, pem: data.pem))
@@ -20,18 +20,9 @@ struct DSCertificatesListCommand: AsyncParsableCommand {
abstract: "List certificates"
)
// swiftlint:disable:next cyclomatic_complexity
func run() async throws {
let client = DeveloperAPIClient(auth: try AuthToken.saved().authData())
let certificates = try await DeveloperAPIPages {
try await client.certificatesGetCollection().ok.body.json
} next: {
$0.links.next
}
.map(\.data)
.reduce(into: [], +=)
let certificates = try await client.certificatesGetCollection().ok.body.json.data
for certificate in certificates {
print("- id: \(certificate.id)")
guard let attributes = certificate.attributes else {
@@ -22,15 +22,7 @@ struct DSDevicesListCommand: AsyncParsableCommand {
func run() async throws {
let client = DeveloperAPIClient(auth: try AuthToken.saved().authData())
let devices = try await DeveloperAPIPages {
try await client.devicesGetCollection().ok.body.json
} next: {
$0.links.next
}
.map(\.data)
.reduce(into: [], +=)
let devices = try await client.devicesGetCollection().ok.body.json.data
for device in devices {
print("- id: \(device.id)")
guard let attributes = device.attributes else {
@@ -22,15 +22,7 @@ struct DSIdentifiersListCommand: AsyncParsableCommand {
func run() async throws {
let client = DeveloperAPIClient(auth: try AuthToken.saved().authData())
let bundleIDs = try await DeveloperAPIPages {
try await client.bundleIdsGetCollection().ok.body.json
} next: {
$0.links.next
}
.map(\.data)
.reduce(into: [], +=)
let bundleIDs = try await client.bundleIdsGetCollection().ok.body.json.data
for bundleID in bundleIDs {
print("- id: \(bundleID.id)")
guard let attributes = bundleID.attributes else {
@@ -22,18 +22,9 @@ struct DSProfilesListCommand: AsyncParsableCommand {
private static let encoder = JSONEncoder()
// swiftlint:disable:next cyclomatic_complexity
func run() async throws {
let client = DeveloperAPIClient(auth: try AuthToken.saved().authData())
let profiles = try await DeveloperAPIPages {
try await client.profilesGetCollection().ok.body.json
} next: {
$0.links.next
}
.map(\.data)
.reduce(into: [], +=)
let profiles = try await client.profilesGetCollection().ok.body.json.data
for profile in profiles {
print("- id: \(profile.id)")
guard let attributes = profile.attributes else {
+9 -166
View File
@@ -2,8 +2,6 @@ import Foundation
import ArgumentParser
import PackLib
import XKit
import Dependencies
import XUtils
struct PackOperation {
struct BuildOptions: ParsableArguments {
@@ -19,9 +17,6 @@ struct PackOperation {
}
}
static let defaultTriple = "arm64-apple-ios"
var triple: String?
var buildOptions = BuildOptions(configuration: .debug)
var xcode = false
@@ -43,7 +38,6 @@ struct PackOperation {
let buildSettings = try await BuildSettings(
configuration: buildOptions.configuration,
triple: triple ?? Self.defaultTriple,
options: []
)
@@ -63,33 +57,7 @@ struct PackOperation {
buildSettings: buildSettings,
plan: plan
)
let bundle = try await packer.pack()
let productsWithEntitlements = plan
.allProducts
.compactMap { p in p.entitlementsPath.map { (p, $0) } }
if !productsWithEntitlements.isEmpty {
let mapping = try await withThrowingTaskGroup(of: (URL, Entitlements).self) { group in
for (product, path) in productsWithEntitlements {
group.addTask {
let data = try await Data(reading: URL(fileURLWithPath: path))
let decoder = PropertyListDecoder()
let entitlements = try decoder.decode(Entitlements.self, from: data)
return (product.directory(inApp: bundle), entitlements)
}
}
return try await group.reduce(into: [:]) { $0[$1.0] = $1.1 }
}
print("Applying entitlements...")
try await Signer.first().sign(
app: bundle,
identity: .adhoc,
entitlementMapping: mapping,
progress: { _ in }
)
}
return bundle
return try await packer.pack()
}
}
@@ -105,6 +73,7 @@ struct DevXcodeCommand: AsyncParsableCommand {
}
}
struct DevBuildCommand: AsyncParsableCommand {
static let configuration = CommandConfiguration(
commandName: "build",
@@ -116,79 +85,8 @@ struct DevBuildCommand: AsyncParsableCommand {
@OptionGroup var packOptions: PackOperation.BuildOptions
@Flag(
name: .shortAndLong,
help: "Codesign the built app",
) var sign = false
@Flag(
name: .shortAndLong,
help: "Output a .ipa file instead of a .app"
) var ipa = false
@Option(
help: ArgumentHelp(
"Custom target triple to build for",
discussion: "Defaults to '\(PackOperation.defaultTriple)'"
)
) var triple: String?
func run() async throws {
let signingAuthToken: AuthToken?
if sign {
guard let token = try AuthToken.savedIfPresent() else {
throw Console.Error("`build --sign` requires logging in with `xtool auth`")
}
signingAuthToken = token
} else {
signingAuthToken = nil
}
let url = try await PackOperation(
triple: triple,
buildOptions: packOptions
).run()
if let signingAuthToken {
let installDelegate = XToolInstallerDelegate()
let installer = IntegratedInstaller(
auth: signingAuthToken.authData(),
delegate: installDelegate
)
do {
defer { print() }
try await installer.signInPlace(app: url)
} catch let error as CancellationError {
throw error
} catch {
print("Error: \(error)")
throw ExitCode.failure
}
}
let finalURL: URL
if ipa {
@Dependency(\.zipCompressor) var compressor
finalURL = url.deletingPathExtension().appendingPathExtension("ipa")
let tmpDir = try TemporaryDirectory(name: "Payload")
let payloadDir = tmpDir.url
try FileManager.default.moveItem(at: url, to: payloadDir.appendingPathComponent(url.lastPathComponent))
let ipaURL = try await compressor.compress(directory: payloadDir) { progress in
if let progress {
let percent = Int(progress * 100)
print("\rPackaging... \(percent)%", terminator: "")
} else {
print("\rPackaging...", terminator: "")
}
}
print()
try? FileManager.default.removeItem(at: finalURL)
try FileManager.default.moveItem(at: ipaURL, to: finalURL)
} else {
finalURL = url
}
print("Wrote to \(finalURL.path)")
try await PackOperation(buildOptions: packOptions).run()
}
}
@@ -203,39 +101,10 @@ struct DevRunCommand: AsyncParsableCommand {
@OptionGroup var packOptions: PackOperation.BuildOptions
#if os(macOS)
@Flag(
name: .shortAndLong,
help: "Target the iOS Simulator"
) var simulator = false
var triple: String? {
if simulator {
#if arch(arm64)
return "arm64-apple-ios-simulator"
#elseif arch(x86_64)
return "x86_64-apple-ios-simulator"
#else
#error("Unsupported architecture")
#endif
}
return nil
}
#else
var triple: String? { nil }
#endif
@OptionGroup var connectionOptions: ConnectionOptions
func run() async throws {
let output = try await PackOperation(triple: triple, buildOptions: packOptions).run()
#if os(macOS)
if simulator {
try await SimInstallOperation(path: output).run()
return
}
#endif
let output = try await PackOperation(buildOptions: packOptions).run()
let token = try AuthToken.saved()
@@ -244,25 +113,16 @@ struct DevRunCommand: AsyncParsableCommand {
let installDelegate = XToolInstallerDelegate()
let installer = IntegratedInstaller(
auth: token.authData(),
udid: client.udid,
lookupMode: .only(client.connectionType),
auth: try token.authData(),
configureDevice: false,
delegate: installDelegate
)
defer { print() }
do {
try await installer.install(
app: output,
udid: client.udid,
lookupMode: .only(client.connectionType),
configureDevice: false,
)
} catch let error as CancellationError {
throw error
} catch {
print("\nError: \(error)")
throw ExitCode.failure
}
try await installer.install(app: output)
}
}
@@ -280,20 +140,3 @@ struct DevCommand: AsyncParsableCommand {
}
extension BuildConfiguration: ExpressibleByArgument {}
#if os(macOS)
struct SimInstallOperation {
var path: URL
// TODO: allow customizing this
var simulator = "booted"
func run() async throws {
let process = Process()
process.executableURL = URL(fileURLWithPath: "/usr/bin/xcrun")
process.arguments = ["simctl", "install", simulator, path.path]
try await process.runUntilExit()
print("Installed to simulator")
}
}
#endif
+7 -11
View File
@@ -24,23 +24,19 @@ struct InstallCommand: AsyncParsableCommand {
let installDelegate = XToolInstallerDelegate()
let installer = IntegratedInstaller(
auth: token.authData(),
udid: client.udid,
lookupMode: .only(client.connectionType),
auth: try token.authData(),
configureDevice: false,
delegate: installDelegate
)
do {
try await installer.install(
app: URL(fileURLWithPath: path),
udid: client.udid,
lookupMode: .only(client.connectionType),
configureDevice: false,
)
try await installer.install(app: URL(fileURLWithPath: path))
print("\nSuccessfully installed!")
} catch let error as CancellationError {
throw error
} catch {
print("\nError: \(error)")
throw ExitCode.failure
print("\nFailed :(")
print("Error: \(error)")
}
}
}
+1 -1
View File
@@ -8,7 +8,7 @@ struct LaunchCommand: AsyncParsableCommand {
commandName: "launch",
abstract: "Launch an installed app"
)
@OptionGroup var connectionOptions: ConnectionOptions
@Argument(
+5 -5
View File
@@ -21,7 +21,6 @@ struct NewCommand: AsyncParsableCommand {
)
) var skipSetup = false
// swiftlint:disable:next function_body_length
func run() async throws {
if !skipSetup {
// perform any remaining setup steps first
@@ -80,7 +79,7 @@ struct NewCommand: AsyncParsableCommand {
.macOS(.v14),
],
products: [
// An xtool project should contain exactly one library product,
// An xtool project should contain exactly one library target,
// representing the main app.
.library(
name: "\(moduleName)",
@@ -115,8 +114,9 @@ struct NewCommand: AsyncParsableCommand {
.swiftpm/configuration/registries.json
.swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata
.netrc
/xtool
/.sourcekit-lsp
"""
),
@@ -135,7 +135,7 @@ struct NewCommand: AsyncParsableCommand {
"Sources/\(moduleName)/\(moduleName)App.swift",
"""
import SwiftUI
@main
struct \(moduleName)App: App {
var body: some Scene {
@@ -151,7 +151,7 @@ struct NewCommand: AsyncParsableCommand {
"Sources/\(moduleName)/ContentView.swift",
"""
import SwiftUI
struct ContentView: View {
var body: some View {
VStack {
@@ -15,7 +15,7 @@ extension ZIPCompressor: DependencyKey {
let zip = Process()
zip.executableURL = try await ToolRegistry.locate("zip")
zip.currentDirectoryURL = dir.deletingLastPathComponent()
zip.arguments = ["-yqru0", dest.path, dir.lastPathComponent]
zip.arguments = ["-yqru0", dest.path, "Payload"]
try await zip.runUntilExit()
return dest
+17 -55
View File
@@ -16,50 +16,28 @@ struct SDKBuilder {
case app(String)
init(path: String) throws {
var isDir: ObjCBool = false
guard FileManager.default.fileExists(atPath: path, isDirectory: &isDir) else {
throw Console.Error("""
Could not read file or directory at path '\(path)'.
See 'xtool help sdk' for usage.
""")
}
let url = URL(fileURLWithPath: path)
if isDir.boolValue {
self = .app(path)
let devDir = url.appendingPathComponent("Contents/Developer")
guard devDir.dirExists else {
throw Console.Error("""
The provided directory at '\(path)' does not appear to be a version of Xcode: \
could not read '\(devDir.path)'.
""")
}
} else {
if path.hasSuffix(".xip") {
self = .xip(path)
let handle = try FileHandle(forReadingFrom: url)
defer { try? handle.close() }
let expectedMagic = "xar!".utf8
let actualMagic = try handle.read(upToCount: expectedMagic.count) ?? Data()
guard actualMagic.elementsEqual(expectedMagic) else {
throw Console.Error("""
The file at '\(path)' does not appear to be a valid XIP file.
""")
}
} else if path.hasSuffix(".app") || path.hasSuffix(".app/") {
self = .app(path)
} else {
throw Console.Error("Expected input path to end in .xip or .app")
}
}
}
let input: Input
let output: URL
let outputPath: String
let arch: Arch
func buildSDK() async throws {
@discardableResult
func buildSDK() async throws -> String {
// TODO: store relevant info for staleness check
let sdkVersion = "develop"
let output = URL(fileURLWithPath: outputPath, isDirectory: true)
.appendingPathComponent("darwin.artifactbundle")
try? FileManager.default.removeItem(at: output)
try FileManager.default.createDirectory(
at: output,
@@ -138,7 +116,6 @@ struct SDKBuilder {
},
"swiftCompiler": {
"extraCLIOptions": [
"-Xfrontend", "-enable-cross-import-overlays",
"-use-ld=lld"
]
}
@@ -167,10 +144,12 @@ struct SDKBuilder {
try Data("\(sdkVersion)\n".utf8)
.write(to: output.appendingPathComponent("darwin-sdk-version.txt"))
return output.path
}
private func installToolset(in output: URL) async throws {
// tag from https://github.com/xtool-org/darwin-tools-linux-llvm
// tag from https://github.com/kabiroberai/darwin-tools-linux-llvm
let darwinToolsVersion = "1.0.1"
let toolsetDir = output.appendingPathComponent("toolset")
@@ -190,7 +169,7 @@ struct SDKBuilder {
@Dependency(\.httpClient) var httpClient
let url = URL(string: """
https://github.com/xtool-org/darwin-tools-linux-llvm/releases/download/\
https://github.com/kabiroberai/darwin-tools-linux-llvm/releases/download/\
v\(darwinToolsVersion)/toolset-\(arch.rawValue).tar.gz
""")!
let (response, body) = try await httpClient.send(HTTPRequest(url: url))
@@ -217,7 +196,6 @@ struct SDKBuilder {
try await tarExit
}
// swiftlint:disable:next cyclomatic_complexity function_body_length
private func installDeveloper(in output: URL) async throws -> URL {
let dev = output.appendingPathComponent("Developer")
@@ -236,19 +214,7 @@ struct SDKBuilder {
try await extractXIP(inputPath: inputPath, outDir: devStage.path)
}.value
try Task.checkCancellation()
let contents = try FileManager.default.contentsOfDirectory(
at: devStage,
includingPropertiesForKeys: nil
)
let apps = contents.filter { $0.pathExtension == "app" }
switch apps.count {
case 0:
throw Console.Error("Unrecognized xip layout (Xcode.app not found)")
case 1:
appDir = apps[0]
default:
throw Console.Error("Unrecognized xip layout (multiple apps found)")
}
appDir = devStage.appendingPathComponent("Xcode.app")
cleanupStageDir = devStage
case .app(let appPath):
wanted = nil
@@ -347,10 +313,6 @@ struct SDKBuilder {
)
}
try FileManager.default.removeItem(
at: dev.appending(path: "Toolchains/XcodeDefault.xctoolchain/usr/lib/swift/clang/include")
)
return dev
}
@@ -368,7 +330,7 @@ struct SDKBuilder {
guard FileManager.default.changeCurrentDirectoryPath(outDir) else {
throw Console.Error("Could not change directory to '\(outDir)'")
}
defer { _ = FileManager.default.changeCurrentDirectoryPath(oldDirectory) }
defer { FileManager.default.changeCurrentDirectoryPath(oldDirectory) }
let inputStream = DataReader.data(readingFrom: fd.rawValue)
+45 -113
View File
@@ -4,7 +4,6 @@ import Version
import ArgumentParser
import Dependencies
import PackLib
import XUtils
struct SDKCommand: AsyncParsableCommand {
static let configuration = CommandConfiguration(
@@ -14,7 +13,6 @@ struct SDKCommand: AsyncParsableCommand {
DevSDKInstallCommand.self,
DevSDKRemoveCommand.self,
DevSDKBuildCommand.self,
DevSDKStatusCommand.self,
],
defaultSubcommand: DevSDKInstallCommand.self
)
@@ -47,10 +45,9 @@ struct DevSDKBuildCommand: AsyncParsableCommand {
func run() async throws {
let builderArch = try arch.sdkBuilderArch
let input = try SDKBuilder.Input(path: path)
let output = URL(fileURLWithPath: outputDir, isDirectory: true).appending(path: "darwin.xtoolsdk")
let builder = SDKBuilder(input: input, output: output, arch: builderArch)
try await builder.buildSDK()
print("Built SDK at \(output.path). You can install it with `xtool sdk install`.")
let builder = SDKBuilder(input: input, outputPath: outputDir, arch: builderArch)
let sdkPath = try await builder.buildSDK()
print("Built SDK at \(sdkPath)")
}
}
@@ -84,8 +81,8 @@ struct DevSDKInstallCommand: AsyncParsableCommand {
)
@Argument(
help: "Path to Xcode.xip, Xcode.app, or darwin.xtoolsdk",
completion: .file(extensions: ["xip", "app", "xtoolsdk"])
help: "Path to Xcode.xip or Xcode.app",
completion: .file(extensions: ["xip", "app"])
)
var path: String
@@ -101,7 +98,7 @@ struct DevSDKRemoveCommand: AsyncParsableCommand {
)
func run() async throws {
guard let sdk = try await DarwinSDK.current() else {
guard let sdk = try DarwinSDK.current() else {
throw Console.Error("Cannot remove SDK: no Darwin SDK installed")
}
try sdk.remove()
@@ -109,22 +106,11 @@ struct DevSDKRemoveCommand: AsyncParsableCommand {
}
}
struct DevSDKStatusCommand: AsyncParsableCommand {
static let configuration = CommandConfiguration(
commandName: "status",
abstract: "Get the status of the Darwin Swift SDK"
)
func run() async throws {
if let sdk = try await DarwinSDK.current() {
print("Installed at \(sdk.bundle.path)")
} else {
print("Not installed")
}
}
}
struct DarwinSDK {
private static let sdksDir = URL(fileURLWithPath: NSHomeDirectory())
.appendingPathComponent(".swiftpm/swift-sdks")
.resolvingSymlinksInPath()
let bundle: URL
let version: String
@@ -133,89 +119,42 @@ struct DarwinSDK {
if let version = try? Data(contentsOf: bundle.appendingPathComponent("darwin-sdk-version.txt")) {
self.version = String(decoding: version, as: UTF8.self)
.trimmingCharacters(in: .whitespacesAndNewlines)
} else if ["darwin.xtoolsdk", "darwin.artifactbundle"].contains(bundle.lastPathComponent) {
} else if bundle.lastPathComponent == "darwin.artifactbundle" {
self.version = "unknown"
} else {
return nil
}
}
static func install(from path: String) async throws {
// we can't just move into ~/.swiftpm/swift-sdks because the swiftpm directory
// location depends on factors like $XDG_CONFIG_HOME. Rather than replicating
// SwiftPM's logic, which may change, it's more reliable to directly invoke
// `swift sdk install`. See: https://github.com/xtool-org/xtool/pull/40
@discardableResult
static func install(movingFrom path: String) throws -> DarwinSDK {
let url = URL(fileURLWithPath: path)
guard DarwinSDK(bundle: url) != nil else { throw Console.Error("Invalid Darwin SDK at '\(path)'")}
try await addHostClangResourceDir(to: url)
let process = Process()
process.executableURL = try await ToolRegistry.locate("swift")
process.arguments = ["sdk", "install", url.path]
try await process.runUntilExit()
let targetURL = sdksDir.appendingPathComponent("darwin.artifactbundle")
if targetURL.exists {
throw Console.Error("Darwin SDK is already installed at '\(targetURL.path)'. Please remove it first.")
}
try FileManager.default.moveItem(at: url, to: targetURL)
guard let sdk = DarwinSDK(bundle: targetURL) else {
throw Console.Error("Darwin SDK failed to install")
}
return sdk
}
private static func addHostClangResourceDir(to sdk: URL) async throws {
let outPipe = Pipe()
let clang = Process()
clang.executableURL = try await ToolRegistry.locate("clang")
clang.arguments = ["-print-resource-dir"]
clang.standardOutput = outPipe
clang.standardError = FileHandle.standardError
async let outputData = Data(reading: outPipe.fileHandleForReading)
do {
try await clang.runUntilExit()
} catch is Process.Failure {
throw Console.Error("Failed to query host clang -print-resource-dir")
}
let path = String(decoding: try await outputData, as: UTF8.self)
.trimmingCharacters(in: .whitespacesAndNewlines)
guard !path.isEmpty else {
throw Console.Error("Host clang returned an empty resource directory")
}
let hostClangResources = URL(fileURLWithPath: path, isDirectory: true)
let hostInclude = hostClangResources.appending(path: "include")
let sdkInclude = sdk.appending(path: "Developer/Toolchains/XcodeDefault.xctoolchain/usr/lib/swift/clang/include")
try FileManager.default.copyItem(at: hostInclude, to: sdkInclude)
}
static func current() async throws -> DarwinSDK? {
let output = Pipe()
let process = Process()
process.executableURL = try await ToolRegistry.locate("swift")
process.arguments = ["sdk", "configure", "darwin", "arm64-apple-ios", "--show-configuration"]
process.standardOutput = output
process.standardError = FileHandle.nullDevice
async let outputData = Data(reading: output.fileHandleForReading)
do {
try await process.runUntilExit()
} catch Process.Failure.exit {
static func current() throws -> DarwinSDK? {
let sdks = (try? FileManager.default.contentsOfDirectory(at: sdksDir, includingPropertiesForKeys: nil)) ?? []
let darwinSDKs = sdks.compactMap { DarwinSDK(bundle: $0) }
switch darwinSDKs.count {
case 0:
return nil
case 1:
return darwinSDKs[0]
default:
throw Console.Error("""
You have multiple copies of the Darwin SDK installed. Please delete all but one to continue.
\(darwinSDKs.map { "- \($0.bundle.path) (version '\($0.version)')" }.joined(separator: "\n"))
""")
}
// should be something like
// swiftResourcesPath: /home/user/.swiftpm/swift-sdks/darwin.artifactbundle/Developer/Toolchains/XcodeDefault.xctoolchain/usr/lib/swift
// swiftlint:disable:previous line_length
let resourcesPathPrefix = "swiftResourcesPath: "
let outputString = String(decoding: try await outputData, as: UTF8.self)
guard let resourcesPath = outputString
.split(separator: "\n")
.first(where: { $0.hasPrefix(resourcesPathPrefix) })?
.dropFirst(resourcesPathPrefix.count)
else { return nil }
var resourcesURL = URL(fileURLWithPath: String(resourcesPath))
for _ in 0..<6 {
resourcesURL = resourcesURL.deletingLastPathComponent()
}
return DarwinSDK(bundle: resourcesURL)
}
func isUpToDate() -> Bool {
@@ -270,31 +209,24 @@ struct InstallSDKOperation {
#if os(macOS)
print("Skipping SDK install; the iOS SDK ships with Xcode on macOS")
#else
let tempDir = try TemporaryDirectory(name: "DarwinSDKBuild")
let sdkPath = tempDir.url.appending(path: "darwin.artifactbundle")
if path.hasSuffix(".xtoolsdk") {
print("Installing prebuilt SDK...")
try FileManager.default.copyItem(at: URL(filePath: path), to: sdkPath)
} else {
// validate input before removing existing SDK
let input = try SDKBuilder.Input(path: path)
let arch = try ArchSelection.auto.sdkBuilderArch
let builder = SDKBuilder(input: input, output: sdkPath, arch: arch)
try await builder.buildSDK()
}
if let sdk = try await DarwinSDK.current() {
if let sdk = try DarwinSDK.current() {
print("Removing existing SDK...")
try sdk.remove()
}
try await DarwinSDK.install(from: sdkPath.path)
let input = try SDKBuilder.Input(path: path)
let arch = try ArchSelection.auto.sdkBuilderArch
let tempDir = try TemporaryDirectory(name: "DarwinSDKBuild")
let builder = SDKBuilder(input: input, outputPath: tempDir.url.path, arch: arch)
let sdkPath = try await builder.buildSDK()
try DarwinSDK.install(movingFrom: sdkPath)
// don't destroy tempDir before this point
withExtendedLifetime(tempDir) {}
print("Installed darwin.artifactbundle")
#endif
}
}
+5 -7
View File
@@ -25,11 +25,9 @@ struct SetupOperation {
try await AuthOperation(logoutFromExisting: false, quiet: quiet).run()
#if os(macOS)
if !quiet {
print("Skipping Darwin SDK setup since we're on macOS.")
}
print("Skipping Darwin SDK setup since we're on macOS.")
#else
switch try await DarwinSDK.current()?.isUpToDate() {
switch try DarwinSDK.current()?.isUpToDate() {
case true?:
if !quiet {
print("Darwin SDK is up to date.")
@@ -42,11 +40,11 @@ struct SetupOperation {
case nil:
let path = try await Console.prompt("""
Now generating the Darwin SDK.
Please download Xcode from http://developer.apple.com/download/all/?q=Xcode
and enter the path to the downloaded Xcode.xip.
Path to Xcode.xip: \("" /* pacify swiftlint trailing_whitespace */)
Path to Xcode.xip:
""")
let expanded = (path as NSString).expandingTildeInPath
+1 -1
View File
@@ -8,7 +8,7 @@ struct UninstallCommand: AsyncParsableCommand {
commandName: "uninstall",
abstract: "Uninstall an installed app"
)
@OptionGroup var connectionOptions: ConnectionOptions
@Argument(
-5
View File
@@ -1,5 +0,0 @@
import CXKit
extension XTool {
public static let version = String(cString: xtl_version())
}
@@ -1,20 +1,17 @@
import Foundation
import XKit
import ArgumentParser
import XUtils
public enum XTool {
public static func run(arguments: [String]? = nil) async throws {
TemporaryDirectory.prepare()
await XToolCommand.cancellableMain(arguments)
}
}
private struct XToolCommand: AsyncParsableCommand {
struct XToolCommand: AsyncParsableCommand {
static let configuration = CommandConfiguration(
commandName: "xtool",
abstract: "Cross-platform Xcode replacement",
version: "xtool \(XTool.version)",
groupedSubcommands: [
CommandGroup(
name: "Configuration",
@@ -45,11 +42,7 @@ private struct XToolCommand: AsyncParsableCommand {
)
}
#if compiler(<6.2)
private typealias SendableMetatype = Any
#endif
extension ParsableCommand where Self: SendableMetatype {
extension ParsableCommand {
fileprivate static func cancellableMain(_ arguments: [String]? = nil) async {
let (canStart, cont) = AsyncStream.makeStream(of: Never.self)
let task = Task {
@@ -66,10 +59,6 @@ extension ParsableCommand where Self: SendableMetatype {
print("Cancelled.")
self.exit()
} catch {
if ProcessInfo.processInfo.environment["XTL_DEBUG_ERRORS"] != nil {
print("ERROR DETAILS:")
print(String(reflecting: error))
}
self.exit(withError: error)
}
}
-25
View File
@@ -1,25 +0,0 @@
import Foundation
extension Data {
// AsyncBytes is Darwin-only :/
package init(reading fileHandle: FileHandle) async throws {
#if canImport(Darwin)
self = try await fileHandle.bytes.reduce(into: Data()) { $0.append($1) }
#else
self = try fileHandle.readToEnd() ?? Data()
#endif
}
package init(reading file: URL) async throws {
#if canImport(Darwin)
self = try await file.resourceBytes.reduce(into: Data()) { $0.append($1) }
#else
try self.init(contentsOf: file)
#endif
}
}
package func stderrPrint(_ message: String, terminator: String = "\n") {
try? FileHandle.standardError.write(contentsOf: Data("\(message)\(terminator)".utf8))
}
-53
View File
@@ -1,53 +0,0 @@
import Foundation
#if canImport(System)
import System
public typealias FilePath = System.FilePath
public typealias FileDescriptor = System.FileDescriptor
public typealias Errno = System.Errno
#else
import SystemPackage
public typealias FilePath = SystemPackage.FilePath
public typealias FileDescriptor = SystemPackage.FileDescriptor
public typealias Errno = SystemPackage.Errno
extension URL {
public init?(filePath: FilePath) {
self.init(filePath: filePath.string)
}
}
extension FilePath {
public init?(_ url: URL) {
guard url.isFileURL else { return nil }
self.init(url.path)
}
}
#endif
extension FileDescriptor {
enum LockMode {
case shared
case exclusive
fileprivate var raw: CInt {
switch self {
case .shared: LOCK_SH
case .exclusive: LOCK_EX
}
}
}
func tryLock(mode: LockMode) throws -> Bool {
if flock(rawValue, mode.raw | LOCK_NB) == 0 {
return true
}
let err = errno
if err == EWOULDBLOCK {
return false
}
throw Errno(rawValue: err)
}
}
-184
View File
@@ -1,184 +0,0 @@
import Foundation
package struct TemporaryDirectory: ~Copyable {
private static let debugTmp = ProcessInfo.processInfo.environment["XTL_DEBUG_TMP"] != nil
private var shouldDelete: Bool
private let base: URL
package let url: URL
/// Prepares a fresh tmpdir root.
///
/// Optional, but try calling this at launch to clean up old resources.
package static func prepare() {
_ = TemporaryDirectoryRoot.shared
}
/// Creates a temporary directory where `lastPathComponent` is exactly `name`.
///
/// The directory is deleted on deinit or (if the object never deinits) on next launch.
/// To save the contents, move them elsewhere with ``persist(at:)``.
package init(name: String) throws {
do {
let basename = name
.replacingOccurrences(of: ".", with: "_")
.replacingOccurrences(of: "/", with: "_")
.prefix(32)
self.base = try TemporaryDirectoryRoot.shared.url
// ensures uniqueness
.appendingPathComponent("dir-\(basename)-\(UUID().uuidString)")
self.url = base.appendingPathComponent(name, isDirectory: true)
self.shouldDelete = true
} catch {
// non-copyable types can't be partially initialized so we need a stub value
self.base = URL(fileURLWithPath: "")
self.url = base
self.shouldDelete = false
throw error
}
try FileManager.default.createDirectory(at: url, withIntermediateDirectories: true)
if Self.debugTmp {
stderrPrint("Created TemporaryDirectory: \(url.path)")
}
}
private func _delete() {
guard !Self.debugTmp else { return }
try? FileManager.default.removeItem(at: base)
}
package consuming func persist(at location: URL) throws {
try FileManager.default.moveItem(at: url, to: location)
_delete()
// we do this after moving, so that if the move fails we clean up
shouldDelete = false
}
deinit {
if shouldDelete { _delete() }
}
}
private struct TemporaryDirectoryRoot {
static let shared = TemporaryDirectoryRoot()
private let _url: Result<URL, Errors>
var url: URL {
get throws(Errors) {
try _url.get()
}
}
private init() {
let url: URL
let env = ProcessInfo.processInfo.environment
if let tmpdir = env["XTL_TMPDIR"] ?? env["TMPDIR"] {
url = URL(fileURLWithPath: tmpdir).appendingPathComponent("sh.xtool")
} else {
#if os(Linux)
// On Linux, /tmp is commonly a tmpfs mount while ~/.swiftpm lives on ext4.
// Foundation's FileManager.copyItem uses sendfile(2) internally, which returns
// EINVAL when copying between different filesystem types (e.g. tmpfs → ext4).
// This causes `swift sdk install` to fail on distros like Linux Mint (#181).
// Using a cache dir on the home filesystem avoids the cross-fs copy entirely.
let xdgCache = env["XDG_CACHE_HOME"].map { URL(fileURLWithPath: $0) }
?? FileManager.default.homeDirectoryForCurrentUser.appendingPathComponent(".cache")
url = xdgCache.appendingPathComponent("xtool")
#else
url = FileManager.default.temporaryDirectory.appendingPathComponent("sh.xtool")
#endif
}
Self.pruneOrphans(in: url)
self._url = Result {
let childDir = try Self.claimDirectory(in: url)
try FileManager.default.createDirectory(at: childDir, withIntermediateDirectories: true)
return childDir
}
.mapError { $0 as? Errors ?? .tmpdirCreationFailed(url, $0) }
}
private static func claimDirectory(in url: URL) throws -> URL {
// create a lockfile + tmpdir. while we hold the lock, other instaces of
// xtool will not delete the directory during their prune step.
try FileManager.default.createDirectory(at: url, withIntermediateDirectories: true)
let pid = ProcessInfo.processInfo.processIdentifier
for i in 0..<10 {
let random = "pid-\(pid)-\(i == 0 ? "0" : UUID().uuidString)"
let lockFile = url.appending(path: "\(random).lock")
#if os(macOS)
let fd = try FileDescriptor.open(
FilePath(lockFile.path),
.writeOnly,
options: [.create, .exclusiveLock],
permissions: [.ownerReadWrite, .groupRead, .otherRead],
)
#else
let fd = try FileDescriptor.open(
FilePath(lockFile.path),
.writeOnly,
options: [.create],
permissions: [.ownerReadWrite, .groupRead, .otherRead],
)
guard try fd.tryLock(mode: .exclusive) else {
// someone else raced us and claimed the right to prune between when we created the file and
// when we tried to lock it
continue
}
#endif
// leak the file descriptor so that the lock is held until the process exits
return url.appending(path: random)
}
throw Errors.tmpdirClaimFailed(url)
}
private static func pruneOrphans(in url: URL) {
guard let children = try? FileManager.default.contentsOfDirectory(at: url, includingPropertiesForKeys: nil)
else { return }
for lock in children {
do {
let basename = lock.lastPathComponent
if basename.hasPrefix("tmp-") {
// legacy tmpdir, remove it
try? FileManager.default.removeItem(at: lock)
continue
}
guard basename.hasPrefix("pid-") && basename.hasSuffix(".lock") else { continue }
let lockFD = try FileDescriptor.open(FilePath(lock.path), .readWrite)
defer { try? lockFD.close() }
if try lockFD.tryLock(mode: .exclusive) {
// we must remove the directory first. if we instead removed the lock first,
// we could be killed after the lock was removed but before the dir was
// removed and therefore leave it hanging around.
do {
try FileManager.default.removeItem(at: lock.deletingPathExtension())
} catch CocoaError.fileNoSuchFile {
// pass
}
try FileManager.default.removeItem(at: lock)
}
} catch {
// continue
}
}
}
enum Errors: Error, CustomStringConvertible {
case tmpdirCreationFailed(URL, Error)
case tmpdirClaimFailed(URL)
var description: String {
switch self {
case let .tmpdirCreationFailed(url, error):
"Could not create temporary directory in '\(url.path)': \(error)"
case let .tmpdirClaimFailed(url):
"Could not claim temporary directory in '\(url.path)'"
}
}
}
}
@@ -21,7 +21,7 @@ You can update your app's bundle ID by editing the `bundleID` field in `xtool.ym
> Note:
>
> xtool adds a prefix to your bundle ID when signing and installing the app on a real device. For example, it may update the above bundle id to `XTL-1234.com.example.Hello`. This is because, at least with free accounts (those not enrolled in the Apple Developer Program), two accounts cannot use the same bundle ID. Prefixing ensures that if you share your app with someone else, they won't run into a bundle ID conflict when installing it.
> xtool adds a prefix to your bundle ID when signing and installing the app on a real device. For example, it may update the above bundle id to `SC-1234.com.example.Hello`. This is because, at least with free accounts (those not enrolled in the Apple Developer Program), two accounts cannot use the same bundle ID. Prefixing ensures that if you share your app with someone else, they won't run into a bundle ID conflict when installing it.
>
> With additional engineering effort, this limitation could be lifted for paid Developer Program users by leveraging wildcard provisioning profiles. If you have a concrete use case for this and/or wish to contribute, please [file an issue](https://github.com/xtool-org/xtool/issues/new).
@@ -107,36 +107,3 @@ iconPath: Resources/AppIcon.png
> Tip:
>
> Your app icon must be a png, and it should ideally have a resolution of 1024x1024px.
## Add entitlements
You may need to add special [entitlements](https://developer.apple.com/documentation/bundleresources/entitlements) to your app, for example you need the `com.apple.developer.homekit` entitlement in order to connect to HomeKit devices.
First create an `App.entitlements` file with the necessary entitlements:
```plist
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>com.apple.developer.homekit</key>
<true/>
</dict>
</plist>
```
Then, tell xtool about it via `xtool.yml`:
```yaml
entitlementsPath: App.entitlements
```
> Troubleshooting:
>
> There are a number of situations in which xtool may not be able to successfully apply an entitlement to your app.
>
> - Some entitlements, such as [Network Extension](https://developer.apple.com/documentation/bundleresources/entitlements/com.apple.developer.networking.networkextension), don't work with free developer accounts. You might need to enrol in one of the Apple Developer Programs to use these.
> - Other entitlements, like [User Notifications Filtering](https://developer.apple.com/documentation/bundleresources/entitlements/com.apple.developer.usernotifications.filtering), require special permission from Apple. If you do have the appropriate permission, these may or may not work with xtool.
> - Many entitlements require specific "Capabilities" to be enabled on your app in the Developer Services portal. xtool handles this for you, but we need to add code to xtool for each Entitlement-Capability mapping. If you run into a Capability that we don't handle yet, please let us know.
>
> Entitlements are a large surface area. If you find any bugs or missing functionality, please [create a GitHub Issue](https://github.com/xtool-org/xtool/issues/new/choose).
@@ -1,10 +1,4 @@
# xtool
@Metadata {
@TechnologyRoot
@TitleHeading("Command-line Tool")
@CallToAction(url: "https://github.com/xtool-org/xtool", label: "View on GitHub")
}
# ``xtool``
Cross-platform Xcode replacement.
@@ -31,4 +25,3 @@ xtool is a cross-platform (Linux/WSL/macOS) tool that replicates Xcode functiona
### Common tasks
- <doc:Control>
- <doc:Appex>

Some files were not shown because too many files have changed in this diff Show More