15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Copyright (c) 2011 The Chromium Authors. All rights reserved. 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// found in the LICENSE file. 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifndef CHROME_COMMON_MAC_LAUNCHD_H_ 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define CHROME_COMMON_MAC_LAUNCHD_H_ 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <CoreFoundation/CoreFoundation.h> 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/basictypes.h" 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/memory/singleton.h" 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class Launchd { 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) enum Type { 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Agent, // LaunchAgent 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Daemon // LaunchDaemon 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) }; 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Domains map to NSSearchPathDomainMask so Foundation does not need to be 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // included. 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) enum Domain { 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) User = 1, // ~/Library/Launch* 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Local = 2, // /Library/Launch* 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Network = 4, // /Network/Library/Launch* 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) System = 8 // /System/Library/Launch* 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) }; 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // TODO(dmaclach): Get rid of this pseudo singleton, and inject it 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // appropriately wherever it is used. 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // http://crbug.com/76925 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static Launchd* GetInstance(); 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~Launchd(); 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Return a dictionary with the launchd export settings. 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual CFDictionaryRef CopyExports(); 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Return a dictionary with the launchd entries for job labeled |name|. 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual CFDictionaryRef CopyJobDictionary(CFStringRef label); 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Return a dictionary for launchd process. 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual CFDictionaryRef CopyDictionaryByCheckingIn(CFErrorRef* error); 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Remove a launchd process from launchd. 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual bool RemoveJob(CFStringRef label, CFErrorRef* error); 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Used by a process controlled by launchd to restart itself. 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // |session_type| can be "Aqua", "LoginWindow", "Background", "StandardIO" or 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // "System". 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // RestartLaunchdJob starts up a separate process to tell launchd to 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // send this process a SIGTERM. This call will return, but a SIGTERM will be 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // received shortly. 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual bool RestartJob(Domain domain, 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Type type, 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) CFStringRef name, 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) CFStringRef session_type); 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Read a launchd plist from disk. 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // |name| should not have an extension. 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual CFMutableDictionaryRef CreatePlistFromFile(Domain domain, 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Type type, 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) CFStringRef name); 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Write a launchd plist to disk. 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // |name| should not have an extension. 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual bool WritePlistToFile(Domain domain, 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Type type, 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) CFStringRef name, 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) CFDictionaryRef dict); 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Delete a launchd plist. 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // |name| should not have an extension. 735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual bool DeletePlist(Domain domain, Type type, CFStringRef name); 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // TODO(dmaclach): remove this once http://crbug.com/76925 is fixed. 765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Scaffolding for doing unittests with our singleton. 775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static void SetInstance(Launchd* instance); 785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) class ScopedInstance { 795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) explicit ScopedInstance(Launchd* instance) { 815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Launchd::SetInstance(instance); 825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ~ScopedInstance() { 845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Launchd::SetInstance(NULL); 855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) }; 875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) protected: 895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Launchd() { } 905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // TODO(dmaclach): remove this once http://crbug.com/76925 is fixed. 935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Scaffolding for doing unittests with our singleton. 945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend struct DefaultSingletonTraits<Launchd>; 955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static Launchd* g_instance_; 965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DISALLOW_COPY_AND_ASSIGN(Launchd); 985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // CHROME_COMMON_MAC_LAUNCHD_H_ 101