Difference between revisions of "Libactivator"

From iPhone Development Wiki
Jump to: navigation, search
m (Formatting.)
m (Unnecessary change inconsistent with standard)
Line 10: Line 10:
 
'''libactivator''' works by connecting an event (represented by an <code>LAEvent</code>) to one or multiple actions (represented by <code>LAListener</code>). Developers can create new events or actions to extend the functionality of a device.
 
'''libactivator''' works by connecting an event (represented by an <code>LAEvent</code>) to one or multiple actions (represented by <code>LAListener</code>). Developers can create new events or actions to extend the functionality of a device.
  
= How to use this library =
+
== How to use this library ==
  
 
Headers are available from [https://github.com/rpetrich/libactivator Activator's GitHub project], and the library can be found at <code>/usr/lib/libactivator.dylib</code> on a device where Activator is installed. If using Theos, place the headers in <code>$THEOS/include/libactivator</code>, the library in <code>$THEOS/lib/</code> and add <code>activator</code> to the <code>XXX_LIBRARIES</code> Makefile variable. See [[#Packaging]] for more usage advice.
 
Headers are available from [https://github.com/rpetrich/libactivator Activator's GitHub project], and the library can be found at <code>/usr/lib/libactivator.dylib</code> on a device where Activator is installed. If using Theos, place the headers in <code>$THEOS/include/libactivator</code>, the library in <code>$THEOS/lib/</code> and add <code>activator</code> to the <code>XXX_LIBRARIES</code> Makefile variable. See [[#Packaging]] for more usage advice.
  
= Observing Events (via LAListener) =
+
== Observing Events (via LAListener) ==
  
 
There are three steps to follow: describing the action, implementing the code, and allowing users to change activation methods. Optionally, you can also add a method to register your plugin for a certain event on installation, which allows you to implement libactivator without confusing prior users.
 
There are three steps to follow: describing the action, implementing the code, and allowing users to change activation methods. Optionally, you can also add a method to register your plugin for a certain event on installation, which allows you to implement libactivator without confusing prior users.
  
== Describing an Action ==
+
=== Describing an Action ===
  
 
Provide information about your listener to libactivator by specifying the group it belongs to, its name and a short description, along with metadata and an icon.
 
Provide information about your listener to libactivator by specifying the group it belongs to, its name and a short description, along with metadata and an icon.
  
=== Title and Description ===
+
==== Title and Description ====
  
 
Provide all the textual information about your listener. You can do so by using a plist or a tweak-like package.
 
Provide all the textual information about your listener. You can do so by using a plist or a tweak-like package.
  
==== Method One: No Code ====
+
===== Method One: No Code =====
  
 
Create a file in the directory <code>/Library/Activator/Listeners/com.your.packageid/</code> named <code>Info.plist</code> with the following contents:
 
Create a file in the directory <code>/Library/Activator/Listeners/com.your.packageid/</code> named <code>Info.plist</code> with the following contents:
Line 40: Line 40:
 
''To do: add a nice table specifying all the valid keys.''
 
''To do: add a nice table specifying all the valid keys.''
  
==== Method Two: Some Code ====
+
===== Method Two: Some Code =====
  
 
The <code>LAListener</code> protocol contains a number of optional methods that are queried by Activator. These can be used if the exact title and description of listeners aren't known until runtime.
 
The <code>LAListener</code> protocol contains a number of optional methods that are queried by Activator. These can be used if the exact title and description of listeners aren't known until runtime.
Line 61: Line 61:
 
''To do: add more API methods, and a short commented description about them.''
 
''To do: add more API methods, and a short commented description about them.''
  
=== Icon ===
+
==== Icon ====
  
 
Provide a visual description of your listener. There are two available options to do so: PNG or PDF.
 
Provide a visual description of your listener. There are two available options to do so: PNG or PDF.
  
==== Method One: No Code ====
+
===== Method One: No Code =====
  
 
Place your icons in <code>/Library/Activator/Listeners/com.your.packageid/</code>
 
Place your icons in <code>/Library/Activator/Listeners/com.your.packageid/</code>
Line 73: Line 73:
 
For the PDF, make a vector image named <code>glyph.pdf</code>.
 
For the PDF, make a vector image named <code>glyph.pdf</code>.
  
==== Method Two: Some Code ====
+
===== Method Two: Some Code =====
  
 
The <code>LAListener</code> protocol contains a number of optional methods that are queried by Activator. These can be used if the icon images of listeners aren't known until runtime.
 
The <code>LAListener</code> protocol contains a number of optional methods that are queried by Activator. These can be used if the icon images of listeners aren't known until runtime.
Line 93: Line 93:
 
''To do: explain image-provider API.''
 
''To do: explain image-provider API.''
  
=== Receiving Raw Events ===
+
==== Receiving Raw Events ====
  
 
Receiving raw events causes the original event behaviour to be suppressed, even in cases where it could leave users "trapped" inside of the application. Listeners that support receiving raw event should specify 'receives-raw-events' = 1; in their listener's Info.plist. Most listeners '''should not''' need to receive raw events.
 
Receiving raw events causes the original event behaviour to be suppressed, even in cases where it could leave users "trapped" inside of the application. Listeners that support receiving raw event should specify 'receives-raw-events' = 1; in their listener's Info.plist. Most listeners '''should not''' need to receive raw events.
Line 99: Line 99:
 
[https://github.com/akeaswaran/ReachWeather/commit/ec0abf61#commitcomment-14259377 rpetrich comments on this and tells us the proper way to do it.]
 
[https://github.com/akeaswaran/ReachWeather/commit/ec0abf61#commitcomment-14259377 rpetrich comments on this and tells us the proper way to do it.]
  
== Implementing the Code ==
+
=== Implementing the Code ===
  
 
Implementing the code can be done in two different methods, depending on your plugin. If you have an object that is always in memory, you can use method one, otherwise, use method two.
 
Implementing the code can be done in two different methods, depending on your plugin. If you have an object that is always in memory, you can use method one, otherwise, use method two.
  
=== Method One: Add the Code ===
+
==== Method One: Add the Code ====
  
 
First, <code>#import <libactivator/libactivator.h></code> and have your class implement the LAListener protocol.
 
First, <code>#import <libactivator/libactivator.h></code> and have your class implement the LAListener protocol.
Line 123: Line 123:
 
The implementation of these methods is left completely up to the programmer. The LAEvent objects can be used to discover more information about the event, such as the type, if you wish to perform a different action based on the type of event. Use the event's <code>userInfo</code> dictionary to get extra information. Do not use that information to disable certain types of events for your plugin!
 
The implementation of these methods is left completely up to the programmer. The LAEvent objects can be used to discover more information about the event, such as the type, if you wish to perform a different action based on the type of event. Use the event's <code>userInfo</code> dictionary to get extra information. Do not use that information to disable certain types of events for your plugin!
  
=== Method Two: New Object ===
+
==== Method Two: New Object ====
  
 
The second method of implementing '''libactivator''' is to insert a new class in your code, one instance of which is always initialized, and informs your main classes when an activation event has occurred (so your main plugin can activate). A sample class is provided below with placeholder comments where additional code would be needed:
 
The second method of implementing '''libactivator''' is to insert a new class in your code, one instance of which is always initialized, and informs your main classes when an activation event has occurred (so your main plugin can activate). A sample class is provided below with placeholder comments where additional code would be needed:
Line 160: Line 160:
 
</source>
 
</source>
  
=== Default Activation Methods ===
+
==== Default Activation Methods ====
  
 
To implement default activation methods, call <code>assignEvent:toListenerWithName:</code> before registering your listener:
 
To implement default activation methods, call <code>assignEvent:toListenerWithName:</code> before registering your listener:
Line 170: Line 170:
 
</source>
 
</source>
  
== Allowing Activator Assignment from a Settings Pane ==
+
=== Allowing Activator Assignment from a Settings Pane ===
  
 
{{main|PreferenceLoader}}
 
{{main|PreferenceLoader}}
Line 176: Line 176:
 
''Modern versions of Activator (1.1 and later) support assigning actions from the settings pane provided via Activator. This section provided for packages that wish to provide integration with their existing settings panes or apps.''
 
''Modern versions of Activator (1.1 and later) support assigning actions from the settings pane provided via Activator. This section provided for packages that wish to provide integration with their existing settings panes or apps.''
  
=== Simple Method ===
+
==== Simple Method ====
  
 
The simplest method to allow users to change activation methods is if you use [[PreferenceLoader]] and a simple plist format. Then, you can just paste in this code to create a cell that when tapped will allow users to select an activation method (again replacing the package id with the correct one):
 
The simplest method to allow users to change activation methods is if you use [[PreferenceLoader]] and a simple plist format. Then, you can just paste in this code to create a cell that when tapped will allow users to select an activation method (again replacing the package id with the correct one):
Line 196: Line 196:
 
If you are assigning a [[flipswitch]], it will be: <code>switch-flip.com.your.packageid</code>
 
If you are assigning a [[flipswitch]], it will be: <code>switch-flip.com.your.packageid</code>
  
=== Advanced Method ===
+
==== Advanced Method ====
  
 
A more complex method is to integrate the settings pane directly into your application's navigation controller:
 
A more complex method is to integrate the settings pane directly into your application's navigation controller:
Line 206: Line 206:
 
</source>
 
</source>
  
= Sending Events (via LAEvent) =
+
== Sending Events (via LAEvent) ==
 
There are 2 steps to follow: dispatching event and providing metadata.
 
There are 2 steps to follow: dispatching event and providing metadata.
  
== Dispatching Events ==
+
=== Dispatching Events ===
 
Custom events can be sent to assigned listeners by constructing an <code>LAEvent</code> object and passing it to the <code>sendEventToListener:</code> method. Activator will take care of looking up which listeners are assigned and delivering the event to them.
 
Custom events can be sent to assigned listeners by constructing an <code>LAEvent</code> object and passing it to the <code>sendEventToListener:</code> method. Activator will take care of looking up which listeners are assigned and delivering the event to them.
  
Line 230: Line 230:
 
If the device is locked and one of the assigned listeners does not support receiving events at the lock screen, Activator will attempt to unlock the device. If a passcode is set, the user will be prompted to enter it.
 
If the device is locked and one of the assigned listeners does not support receiving events at the lock screen, Activator will attempt to unlock the device. If a passcode is set, the user will be prompted to enter it.
  
== Providing Event Metadata ==
+
=== Providing Event Metadata ===
 
Activator requires metadata on which events are possible to allow assignment through the settings pane.
 
Activator requires metadata on which events are possible to allow assignment through the settings pane.
  
Line 291: Line 291:
 
Registering <code>LAEventDataSource</code>s must be performed from within SpringBoard.
 
Registering <code>LAEventDataSource</code>s must be performed from within SpringBoard.
  
= Packaging =
+
== Packaging ==
  
 
Packages that provide Activator actions or events (especially if this is their primary purpose) should set up a dependency on the earliest version of Activator they support, as part of their package's control file:
 
Packages that provide Activator actions or events (especially if this is their primary purpose) should set up a dependency on the earliest version of Activator they support, as part of their package's control file:
Line 306: Line 306:
 
</source>
 
</source>
  
== Runtime access to Activator ==
+
=== Runtime access to Activator ===
  
 
If you do not want to depend on libactivator being installed, you can use the following snippet as a starting line, to access Activator APIs:
 
If you do not want to depend on libactivator being installed, you can use the following snippet as a starting line, to access Activator APIs:
Line 322: Line 322:
 
</source>
 
</source>
  
= Examples =
+
== Examples ==
  
== LAListeners ==
+
=== LAListeners ===
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 347: Line 347:
 
|}
 
|}
  
== LAEvents ==
+
=== LAEvents ===
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 364: Line 364:
 
|}
 
|}
  
= External links =
+
== External links ==
  
 
* [http://github.com/rpetrich/libactivator/tree/master/ libactivator GitHub]
 
* [http://github.com/rpetrich/libactivator/tree/master/ libactivator GitHub]

Revision as of 03:23, 11 April 2016


Libactivator
Cydia Package
Developer Ryan Petrich
Package ID libactivator
Latest Version 1.9.0


libactivator is a library that provides a centralized system of activation methods for all of our jailbroken extensions. To accomplish this, the hooks of the activation methods are in one centralized Substrate plugin, which uses small bundles and preference panes to select the activation method for each plugin.

libactivator works by connecting an event (represented by an LAEvent) to one or multiple actions (represented by LAListener). Developers can create new events or actions to extend the functionality of a device.

How to use this library

Headers are available from Activator's GitHub project, and the library can be found at /usr/lib/libactivator.dylib on a device where Activator is installed. If using Theos, place the headers in $THEOS/include/libactivator, the library in $THEOS/lib/ and add activator to the XXX_LIBRARIES Makefile variable. See #Packaging for more usage advice.

Observing Events (via LAListener)

There are three steps to follow: describing the action, implementing the code, and allowing users to change activation methods. Optionally, you can also add a method to register your plugin for a certain event on installation, which allows you to implement libactivator without confusing prior users.

Describing an Action

Provide information about your listener to libactivator by specifying the group it belongs to, its name and a short description, along with metadata and an icon.

Title and Description

Provide all the textual information about your listener. You can do so by using a plist or a tweak-like package.

Method One: No Code

Create a file in the directory /Library/Activator/Listeners/com.your.packageid/ named Info.plist with the following contents:

{
    group = "My Listener Group";
    title = "My Listener";
    description = "Human Readable Description";
    "compatible-modes" = ("springboard", "lockscreen", "application");
}

To do: add a nice table specifying all the valid keys.

Method Two: Some Code

The LAListener protocol contains a number of optional methods that are queried by Activator. These can be used if the exact title and description of listeners aren't known until runtime.

- (NSString *)activator:(LAActivator *)activator requiresLocalizedGroupForListenerName:(NSString *)listenerName {
	return @"My Listener Group";
}
- (NSString *)activator:(LAActivator *)activator requiresLocalizedTitleForListenerName:(NSString *)listenerName {
	return @"My Listener";
}
- (NSString *)activator:(LAActivator *)activator requiresLocalizedDescriptionForListenerName:(NSString *)listenerName {
	return @"Human Readable Description";
}
- (NSArray *)activator:(LAActivator *)activator requiresCompatibleEventModesForListenerWithName:(NSString *)listenerName {
	return [NSArray arrayWithObjects:@"springboard", @"lockscreen", @"application", nil];
}

To do: add more API methods, and a short commented description about them.

Icon

Provide a visual description of your listener. There are two available options to do so: PNG or PDF.

Method One: No Code

Place your icons in /Library/Activator/Listeners/com.your.packageid/

For the PNG, make a 29x29 pixels image named icon-small.png. Optionally an @2x version, icon-small@2x.png.

For the PDF, make a vector image named glyph.pdf.

Method Two: Some Code

The LAListener protocol contains a number of optional methods that are queried by Activator. These can be used if the icon images of listeners aren't known until runtime.

//  Fast path that supports scale
- (NSData *)activator:(LAActivator *)activator requiresIconDataForListenerName:(NSString *)listenerName scale:(CGFloat *)scale;
- (NSData *)activator:(LAActivator *)activator requiresSmallIconDataForListenerName:(NSString *)listenerName scale:(CGFloat *)scale;
//  Legacy
- (NSData *)activator:(LAActivator *)activator requiresIconDataForListenerName:(NSString *)listenerName;
- (NSData *)activator:(LAActivator *)activator requiresSmallIconDataForListenerName:(NSString *)listenerName;
//  For cases where PNG data isn't available quickly
- (UIImage *)activator:(LAActivator *)activator requiresIconForListenerName:(NSString *)listenerName scale:(CGFloat)scale;
- (UIImage *)activator:(LAActivator *)activator requiresSmallIconForListenerName:(NSString *)listenerName scale:(CGFloat)scale;

- (id)activator:(LAActivator *)activator requiresGlyphImageDescriptorForListenerName:(NSString *)listenerName;

To do: explain image-provider API.

Receiving Raw Events

Receiving raw events causes the original event behaviour to be suppressed, even in cases where it could leave users "trapped" inside of the application. Listeners that support receiving raw event should specify 'receives-raw-events' = 1; in their listener's Info.plist. Most listeners should not need to receive raw events.

rpetrich comments on this and tells us the proper way to do it.

Implementing the Code

Implementing the code can be done in two different methods, depending on your plugin. If you have an object that is always in memory, you can use method one, otherwise, use method two.

Method One: Add the Code

First, #import <libactivator/libactivator.h> and have your class implement the LAListener protocol.

To register for events, you must add a piece of code to your init method, replacing the parts as needed:

[LASharedActivator registerListener:YOUR_SHARED_OBJECT forName:@"com.your.packageid"];

Then, you must also implement two simple delegate methods:

- (void)activator:(LAActivator *)activator receiveEvent:(LAEvent *)event;
- (void)activator:(LAActivator *)activator abortEvent:(LAEvent *)event;

In the first method, you should first check if your plugin is already active. If it is active, you should deactivate your plugin and return. Otherwise, just activate your plugin. In addition, in the activator:recieveEvent: method, you must call [event setHandled:YES] if you wish to disable the default OS action for that activation event. If you do not set handled then receive event may be called twice for the same event. In the second method you should simply deactivate your plugin.

The implementation of these methods is left completely up to the programmer. The LAEvent objects can be used to discover more information about the event, such as the type, if you wish to perform a different action based on the type of event. Use the event's userInfo dictionary to get extra information. Do not use that information to disable certain types of events for your plugin!

Method Two: New Object

The second method of implementing libactivator is to insert a new class in your code, one instance of which is always initialized, and informs your main classes when an activation event has occurred (so your main plugin can activate). A sample class is provided below with placeholder comments where additional code would be needed:

#import <libactivator/libactivator.h>
#import <UIKit/UIKit.h>

@interface LAExample : NSObject <LAListener>
@end

@implementation LAExample

- (void)activator:(LAActivator *)activator receiveEvent:(LAEvent *)event {
	if (/* your plugin is activated */) {
		// Dismiss your plugin
		return;
	}
	
	// Activate your plugin

	[event setHandled:YES]; // To prevent the default OS implementation
}

- (void)activator:(LAActivator *)activator abortEvent:(LAEvent *)event {
	// Dismiss your plugin
}

+ (void)load {
	if ([LASharedActivator isRunningInsideSpringBoard]) {
		[LASharedActivator registerListener:[self new] forName:@"com.your.packageid"];
	}
}

@end

Default Activation Methods

To implement default activation methods, call assignEvent:toListenerWithName: before registering your listener:

if (![LASharedActivator hasSeenListenerWithName:@"com.your.packageid"]) {
	[LASharedActivator assignEvent:[LAEvent eventWithName:@"libactivator.motion.shake"] toListenerWithName:@"com.your.packageid"];
}

Allowing Activator Assignment from a Settings Pane

Modern versions of Activator (1.1 and later) support assigning actions from the settings pane provided via Activator. This section provided for packages that wish to provide integration with their existing settings panes or apps.

Simple Method

The simplest method to allow users to change activation methods is if you use PreferenceLoader and a simple plist format. Then, you can just paste in this code to create a cell that when tapped will allow users to select an activation method (again replacing the package id with the correct one):

<dict>
	<key>cell</key>
	<string>PSLinkCell</string>
	<key>label</key>
	<string>Activation Methods</string>
	<key>isController</key>
	<true/>
	<key>bundle</key>
	<string>LibActivator</string>
	<key>activatorListener</key>
	<string>com.your.packageid</string>
</dict>

If you are assigning a flipswitch, it will be: switch-flip.com.your.packageid

Advanced Method

A more complex method is to integrate the settings pane directly into your application's navigation controller:

LAListenerSettingsViewController *vc = [[LAListenerSettingsViewController new] autorelease];
vc.listenerName = @"com.your.packageid";
[myNavigationController pushViewController:vc animated:YES];

Sending Events (via LAEvent)

There are 2 steps to follow: dispatching event and providing metadata.

Dispatching Events

Custom events can be sent to assigned listeners by constructing an LAEvent object and passing it to the sendEventToListener: method. Activator will take care of looking up which listeners are assigned and delivering the event to them.

Example event dispatch using the _awayControllerUnlocked: method of SBIconController

%hook SBIconController

- (void)_awayControllerUnlocked:(id)unlocked {
        LAEvent *event = [LAEvent eventWithName:@"com.your.packageid.springboard.unlocked" mode:[LASharedActivator currentEventMode]];
        [LASharedActivator sendEventToListener:event];
        if (event.handled) {
                NSLog(@"Event was handled by an assignment in Activator!");
        }
        %orig();
}

%end

If the device is locked and one of the assigned listeners does not support receiving events at the lock screen, Activator will attempt to unlock the device. If a passcode is set, the user will be prompted to enter it.

Providing Event Metadata

Activator requires metadata on which events are possible to allow assignment through the settings pane.

The simplest way to provide event metadata is to create a subfolder in /Library/Activator/Events with the name of your event, and describe it using an Info.plist:

/Library/Activator/Events/com.your.packageid.springboard.unlocked/Info.plist:

{
	title = "Unlock Succeeded";
	group = "Unlocking";
	description = "Device unlock succeeded";
}

Alternatively, event metadata can be setup by passing an object conforming to LAEventDataSource to LAActivator's registerEventDataSource:forEventName: method. This allows for adding and removing events based on runtime conditions.

Equivalent example, performed in code:

@interface SomeDataSource: NSObject <LAEventDataSource>
@end

@implementation SomeDataSource

static SomeDataSource *myDataSource;

+ (void)load
{
        @autoreleasepool {
                myDataSource = [[SomeDataSource alloc] init];
        }
}

- (id)init {
        if ((self = [super init])) {
                [LASharedActivator registerEventDataSource:self forEventName:@"com.your.packageid.springboard.unlocked"];
        }
        return self;
}

- (void)dealloc {
        [LASharedActivator unregisterEventDataSourceWithEventName:@"com.your.packageid.springboard.unlocked"];
        [super dealloc];
}

- (NSString *)localizedTitleForEventName:(NSString *)eventName {
        return @"Unlock Succeeded";
}

- (NSString *)localizedGroupForEventName:(NSString *)eventName {
        return @"Unlocking";
}

- (NSString *)localizedDescriptionForEventName:(NSString *)eventName {
        return @"Device unlock succeeded";
}

@end

Registering LAEventDataSources must be performed from within SpringBoard.

Packaging

Packages that provide Activator actions or events (especially if this is their primary purpose) should set up a dependency on the earliest version of Activator they support, as part of their package's control file:

Depends: libactivator (>= 1.8.3), mobilesubstrate

Packages that work without Activator installed but still provide some level of Activator integration should conflict with older versions of Activator that they are untested with:

Depends: mobilesubstrate
Conflicts: libactivator (<< 1.8.3)

Runtime access to Activator

If you do not want to depend on libactivator being installed, you can use the following snippet as a starting line, to access Activator APIs:

...
dlopen("/usr/lib/libactivator.dylib", RTLD_LAZY);
Class la = objc_getClass("LAActivator");
if (la) { //libactivator is installed
	...
} else {  //libactivator is not installed
	...
}
...

Examples

LAListeners

Project Author
BrightVol HASHBANG
NowNow Nick Frey
slideback twodayslate
SpeakTime Callum Ryan
ActivatorPopup Sassoty

LAEvents

Project Author
UnlockEvents uroboro
GeoEvent for Activator r_plus
Dropped James-Isaac-Neutron

External links