Libactivator

From iPhone Development Wiki
Revision as of 12:17, 26 August 2013 by Bushe (talk | contribs)
Jump to: navigation, search
Libactivator
Cydia Package
Developer Ryan Petrich
Package ID libactivator
Latest Version 1.8.1


libactivator is a library used to have 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 MobileSubstrate plugin, that uses small bundles and preference panes to select the activation method for each plugin.

libactivator github libactivator.h

Implementing libactivator

To support libactivator, there are three steps you must follow: integrating the code, adding an activation plist, and adding a method to set the 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.

Integrating the Code

Integrating 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:

[[LAActivator sharedInstance] 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. 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. 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
{
	[[LAActivator sharedInstance] registerListener:[self new] forName:@"com.your.packageid"];
}

@end

Adding a plist

The most simple step. Simply add a plist to your file system in the folder /Library/Activator/Listeners/com.your.packageid/Info.plist. The contents of this file should contain, inserting the proper text:

{
	title = "HUMAN_READABLE_PLUGIN_NAME";
	description = "HUMAN_READABLE_PLUGIN_DESCRIPTION";
	"compatible-modes" = ("springboard", "application", "lockscreen");
}

Allowing Users to Change Activation Methods

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>

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

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

Libactivator 1.1 introduces a global preferences pane and makes neither of these methods required

Default Activation Methods

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

+ (void)load
{
	if (![[LAActivator sharedInstance] hasSeenListenerWithName:@"com.your.packageid"])
		[[LAActivator sharedInstance] assignEvent:[LAEvent eventWithName:@"libactivator.motion.shake"] toListenerWithName:@"com.your.packageid"];
	[[LAActivator sharedInstance] registerListener:[self new] forName:@"com.your.packageid"];
}

Only supported in libactivator 1.1+