├── .gitignore
├── usr
    └── lib
    │   └── libmessagelog.dylib
├── control
├── Makefile
├── MessageLog.h
├── .travis.yml
├── README.md
└── MessageLog.xm


/.gitignore:
--------------------------------------------------------------------------------
1 | packages
2 | .theos
3 | 


--------------------------------------------------------------------------------
/usr/lib/libmessagelog.dylib:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Muirey03/MessageLog/HEAD/usr/lib/libmessagelog.dylib


--------------------------------------------------------------------------------
/control:
--------------------------------------------------------------------------------
 1 | Package: com.muirey03.messagelog
 2 | Name: MessageLog
 3 | Depends: mobilesubstrate
 4 | Version: 1.0.0
 5 | Architecture: iphoneos-arm
 6 | Description: A simple library to log all objc_msgSend calls
 7 | Maintainer: Muirey03
 8 | Author: Muirey03
 9 | Section: Tweaks
10 | 


--------------------------------------------------------------------------------
/Makefile:
--------------------------------------------------------------------------------
 1 | export ARCHS = arm64 armv7 arm64e
 2 | 
 3 | include $(THEOS)/makefiles/common.mk
 4 | 
 5 | LIBRARY_NAME = libmessagelog
 6 | libmessagelog_FILES = MessageLog.xm
 7 | libmessagelog_LIBRARIES = substrate
 8 | ADDITIONAL_CFLAGS = -DTHEOS_LEAN_AND_MEAN
 9 | 
10 | include $(THEOS_MAKE_PATH)/library.mk
11 | 
12 | internal-stage::
13 | 	mkdir -p usr/lib
14 | 	cp $(THEOS_STAGING_DIR)/usr/lib/libmessagelog.dylib usr/lib/libmessagelog.dylib
15 | 


--------------------------------------------------------------------------------
/MessageLog.h:
--------------------------------------------------------------------------------
 1 | #ifndef MESSAGE_LOG_H
 2 | #define MESSAGE_LOG_H
 3 | 
 4 | #ifdef __cplusplus
 5 | extern "C" {
 6 | #else
 7 | #include <stdbool.h>
 8 | #endif
 9 | 
10 | typedef void (*MLLoggerFunc_t)(bool, const char*, const char*);
11 | // Set a custom logging function to use instead of the default
12 | void MLSetLogger(MLLoggerFunc_t logger);
13 | 
14 | // Enable/disable logging of every selector on every class
15 | void MLSetFullLoggingEnabled(bool enabled);
16 | 
17 | typedef NS_ENUM(NSInteger, MLMethodType)
18 | {
19 | 	MLMethodTypeAny,
20 | 	MLMethodTypeClass,
21 | 	MLMethodTypeInstance
22 | };
23 | // Enable selective logging
24 | void MLEnableSelectiveLogging(MLMethodType type, const char* classRegex, const char* selectorRegex);
25 | 
26 | // Disable selective logging
27 | void MLDisableSelectiveLogging(void);
28 | 
29 | // Log methods called by a block of code
30 | void MLLogBlock(void(^block)(void));
31 | 
32 | #ifdef __cplusplus
33 | }
34 | #endif
35 | 
36 | #endif //MESSAGE_LOG_H
37 | 


--------------------------------------------------------------------------------
/.travis.yml:
--------------------------------------------------------------------------------
 1 | os: osx
 2 | language: objective-c
 3 | osx_image: xcode10.1
 4 | sudo: false
 5 | env:
 6 |   global:
 7 |   - THEOS=~/theos
 8 | before_install:
 9 | - brew install dpkg ldid
10 | - git clone --recursive git://github.com/theos/theos.git ~/theos
11 | script:
12 | - make clean package FINALPACKAGE=1
13 | before_deploy:
14 | - git config --local user.name "Muirey03"
15 | - git config --local user.email "tommy.muir@btinternet.com"
16 | - export RELEASE_PKG_FILE=$(ls ./packages/*.deb)
17 | - export TRAVIS_TAG=${TRAVIS_TAG:-$(date +'%Y%m%d%H%M%S')-$(git log --format=%h -1)}
18 | - git tag $TRAVIS_TAG
19 | deploy:
20 |   provider: releases
21 |   skip_cleanup: true
22 |   api_key:
23 |     secure: EeRHLS7Chwm5+oHGqBoNPbCZZnemm19qnO4QwvVV/43A2F0IZ+QIdCwuyyfm/OUsTfarbIKA2okHQMiBOXImudvUWTA8lojxMyeJXnVvhByVBDWXnwLYkfeAsazb8ypVBKlgs8B+X4dxWXnhrenMAyoBigDZkcD3CSeMRsIhi64uF+zfJZ4yvUmdHq9Iz+x9lc8DaWahFe88J2IIQ0nDQQGPNvZXErG+PFEQuZjou9D6VfgO8nM0bp/ZNJzbkP8o1dI9a441sBzLkfwjWRnY5Gg1XDDmnSzpHd8bZydIeQybJTyg2FDrgMs4eP7RgDpyIB3j0Hi0/BHI37b2UW5Qx4x2tkZ+JZN/W1fT/fhZ77RCmRSUXSCsVkh69LKwQAWjnVN2oBnJ1IuO5oaxUl5RMe+v+pHhfN3cpaW64AqItF7/b85yob2no9tC8JSolmbWonjSgIDqtO2Kg95lm02yRhc+fEi3LNbFFGu0EcotbGJkxt7wRXrBsc4+ISE2ER+a7wJjhDLaxIRtDt/0WtlGs80C6pMvHEN6cprs16I6I5vAkr4azV2EVOxtE8axKHrvC5Mg9Z76h4g2jAn888NvYXSK8caZj9cMaIYx9KmAFBcXOqSuNHfphGfedIYKW4m5KIMaPWrZJhP6f/ItS+Sp0BXf7AkurylhhkGeEgYQN/Y=
24 |   file_glob: true
25 |   file: "${RELEASE_PKG_FILE}"
26 |   on:
27 |     repo: Muirey03/MessageLog
28 |     branch: master
29 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # MessageLog
 2 | ### A simple library to log all objc_msgSend calls
 3 | 
 4 | MessageLog is a small library to log Objective-C method calls. It can be used to either log all messages, or to filter messages based off regular expressions, and even to implement your own logging functions. The default log location is `/tmp/MessageLog/objcMessages~<processname>_<time>.txt`.
 5 | 
 6 | ## Usage
 7 | 
 8 | First copy `MessageLog.h` to `$THEOS/include`, then copy `usr/lib/libmessagelog.dylib` to `$THEOS/lib`. You can then add `XXX_LIBRARIES = messagelog` to the Makefile of any project you want to use it, and `#import <MessageLog.h>` to source files you want to use it in. Ensure the library is installed on any devices you try to use it on.
 9 | 
10 | ### Enabling logs for all methods:
11 | 
12 | 	void MLSetFullLoggingEnabled(bool enabled);
13 | To enable logs for all methods, call `MLSetFullLoggingEnabled(true);`. Call `MLSetFullLoggingEnabled(false);` afterwards to halt the logs.
14 | 
15 | 
16 | ### Enabling logs based of regular expressions:
17 | To filter logs by regex, use:
18 | 
19 | 	void MLEnableSelectiveLogging(MLMethodType type, const char* classRegex, const char* selectorRegex);
20 | `type` can be either `MLMethodTypeAny`, `MLMethodTypeClass` or `MLMethodTypeInstance`. Use `MLMethodTypeAny` if you do not want to filter by method type, `MLMethodTypeClass` if you want to only log class methods, and `MLMethodTypeInstance` if you want to only log instance methods.
21 | 
22 | `classRegex` should be set to a regular expression for which to filter the class by. Only classes matching this expression will be logged. Set this to `NULL` if you do not want to filter by class.
23 | 
24 | `selectorRegex` should be set to a regular expression for which to filter the selector by. Only selectors matching this expression will be logged. Set this to `NULL` if you do not want to filter by selector.
25 | 
26 | `MLDisableSelectiveLogging();` should be called to disable the logging once you are done.
27 | 
28 | 
29 | ### Using custom loggers:
30 | Sometimes, it will be desirable to use custom logging logic, MessageLog makes this easy with the `MLSetLogger` function:
31 | 
32 | 	void MLSetLogger(MLLoggerFunc_t logger);
33 | `logger` should be a function of type `MLLoggerFunc_t`:
34 | 
35 | 	typedef void (*MLLoggerFunc_t)(bool, const char*, const char*);
36 | where the arguments are:
37 | 
38 | 	bool isClassMethod, const char* className, const char* selectorName
39 | 
40 | Here is an example usage:
41 | 
42 | 	void customLogger(bool isClassMethod, const char* className, const char* selectorName)
43 | 	{
44 | 		NSLog(@"[MyTweak] %c[%s %s]", isClassMethod ? '+' : '-', className, selectorName);
45 | 	}
46 | 
47 | 
48 | ## Credits
49 | Feel free to follow me on Twitter [@Muirey03](https://twitter.com/muirey03). If you have any contributions you want to make to this, please submit a Pull Request.
50 | 


--------------------------------------------------------------------------------
/MessageLog.xm:
--------------------------------------------------------------------------------
  1 | @import Foundation;
  2 | #import <objc/runtime.h>
  3 | #include <string>
  4 | #include <sstream>
  5 | #include <regex.h>
  6 | #include <substrate.h>
  7 | #include <pthread.h>
  8 | #import "MessageLog.h"
  9 | 
 10 | static void openLogFile(void);
 11 | static void closeLogFile(void);
 12 | static void flushCaches();
 13 | static void defaultLogger(bool isCls, const char* clsName, const char* selName);
 14 | 
 15 | static IMP (*lookUpImpOrForwardPtr)(Class, SEL, id, bool, bool, bool) = NULL;
 16 | static FILE* logFile = NULL;
 17 | static MLLoggerFunc_t MLLoggerFunc = &defaultLogger;
 18 | static bool loggingEnabled = false;
 19 | static MLMethodType matchType = MLMethodTypeAny;
 20 | static regex_t* matchClassRegex = nullptr;
 21 | static regex_t* matchSelRegex = nullptr;
 22 | static pthread_t inspectedThread = NULL;
 23 | 
 24 | extern "C"
 25 | {
 26 | 	void MLSetLogger(MLLoggerFunc_t logger)
 27 | 	{
 28 | 		MLLoggerFunc = logger;
 29 | 	}
 30 | 
 31 | 	void MLSetFullLoggingEnabled(bool enabled)
 32 | 	{
 33 | 		if (loggingEnabled == enabled)
 34 | 			return;
 35 | 		
 36 | 		if (enabled)
 37 | 			flushCaches();
 38 | 
 39 | 		matchType = MLMethodTypeAny;
 40 | 		if (matchClassRegex)
 41 | 			delete matchClassRegex, matchClassRegex = nullptr;
 42 | 		if (matchSelRegex)
 43 | 			delete matchSelRegex, matchSelRegex = nullptr;
 44 | 		
 45 | 		if (MLLoggerFunc == &defaultLogger)
 46 | 		{
 47 | 			if (enabled)
 48 | 			{
 49 | 				//open log file for appending
 50 | 				openLogFile();
 51 | 			}
 52 | 			else
 53 | 			{
 54 | 				//close log file
 55 | 				closeLogFile();
 56 | 			}
 57 | 		}
 58 | 		loggingEnabled = enabled;
 59 | 	}
 60 | 
 61 | 	void MLEnableSelectiveLogging(MLMethodType type, const char* classRegex, const char* selectorRegex)
 62 | 	{
 63 | 		flushCaches();
 64 | 
 65 | 		matchType = type;
 66 | 		if (classRegex)
 67 | 		{
 68 | 			matchClassRegex = new regex_t;
 69 | 			int ret = regcomp(matchClassRegex, classRegex, REG_ICASE);
 70 | 			if (ret)
 71 | 				delete matchClassRegex, matchClassRegex = nullptr;
 72 | 		}
 73 | 		if (selectorRegex)
 74 | 		{
 75 | 			matchSelRegex = new regex_t;
 76 | 			int ret = regcomp(matchSelRegex, selectorRegex, 0);
 77 | 			if (ret)
 78 | 				delete matchSelRegex, matchSelRegex = nullptr;
 79 | 		}
 80 | 		if (MLLoggerFunc == &defaultLogger)
 81 | 			openLogFile();
 82 | 		loggingEnabled = YES;
 83 | 	}
 84 | 
 85 | 	void MLDisableSelectiveLogging()
 86 | 	{
 87 | 		MLSetFullLoggingEnabled(false);
 88 | 	}
 89 | 
 90 | 	void MLLogBlock(void(^block)(void))
 91 | 	{
 92 | 		inspectedThread = pthread_self();
 93 | 		MLSetFullLoggingEnabled(true);
 94 | 		block();
 95 | 		MLSetFullLoggingEnabled(false);
 96 | 		inspectedThread = NULL;
 97 | 	}
 98 | }
 99 | 
100 | static void openLogFile()
101 | {
102 | 	if (logFile) return;
103 | 	std::stringstream ss;
104 | 	ss << "/tmp/MessageLog/objcMessages~" << getprogname() << "_" << time(NULL) << ".txt";
105 | 	std::string filenameStr = ss.str();
106 | 	logFile = fopen(filenameStr.c_str(), "a");
107 | 	NSLog(@"[MobileLogger] Logging started to %s", filenameStr.c_str());
108 | }
109 | 
110 | static void closeLogFile()
111 | {
112 | 	if (!logFile) return;
113 | 	fclose(logFile);
114 | 	logFile = NULL;
115 | }
116 | 
117 | static void defaultLogger(bool isCls, const char* clsName, const char* selName)
118 | {
119 | 	fprintf(logFile, "%c[%s %s]\n", isCls ? '+' : '-', clsName, selName);
120 | }
121 | 
122 | static void flushCaches()
123 | {
124 | 	//flush caches when logging starts so we gets traces
125 | 	#pragma clang diagnostic push
126 | 	#pragma clang diagnostic ignored "-Wdeprecated-declarations"
127 | 	_objc_flush_caches(nil);
128 | 	#pragma clang diagnostic pop
129 | }
130 | 
131 | %hookf (IMP, lookUpImpOrForwardPtr, Class cls, SEL sel, id inst, bool initialize, bool cache, bool resolver)
132 | {
133 | 	if (loggingEnabled && (!inspectedThread || pthread_equal(inspectedThread, pthread_self())) && inst && sel)
134 | 	{
135 | 		loggingEnabled = false;
136 | 		//don't cache anything when we're logging
137 | 		cache = false;
138 | 
139 | 		bool isCls = class_isMetaClass(inst);
140 | 		const char* clsName = class_getName(inst);
141 | 		const char* selName = sel_getName(sel);
142 | 
143 | 		bool match = true;
144 | 		if ((isCls && matchType == MLMethodTypeInstance) || (!isCls && matchType == MLMethodTypeClass))
145 | 			match = false;
146 | 		if (match && matchClassRegex)
147 | 			match = (regexec(matchClassRegex, clsName, 0, NULL, 0) == 0);
148 | 		if (match && matchSelRegex)
149 | 			match = (regexec(matchSelRegex, selName, 0, NULL, 0) == 0);
150 | 
151 | 		if (match)
152 | 			MLLoggerFunc(isCls, clsName ?: "<null>", selName ?: "<null>");
153 | 		loggingEnabled = true;
154 | 	}
155 | 	return %orig;
156 | }
157 | 
158 | %ctor
159 | {
160 | 	@autoreleasepool
161 | 	{
162 | 		lookUpImpOrForwardPtr = (IMP (*)(Class, SEL, id, bool, bool, bool))MSFindSymbol(MSGetImageByName("/usr/lib/libobjc.A.dylib"), "_lookUpImpOrForward");
163 | 		%init;
164 | 	}
165 | }
166 | 


--------------------------------------------------------------------------------