diff options
| -rw-r--r-- | .gitignore | 2 | ||||
| -rw-r--r-- | README.md | 2 | ||||
| -rw-r--r-- | config.php | 9 | ||||
| -rw-r--r-- | functions.php | 20 | ||||
| -rw-r--r-- | postform.inc.php | 10 | ||||
| -rw-r--r-- | single.inc.php | 1 | ||||
| -rw-r--r-- | timeline.inc.php | 1 | ||||
| -rw-r--r-- | twitter_api.php | 410 |
8 files changed, 452 insertions, 3 deletions
@@ -1,2 +1,2 @@ -posts.db +*.db feed.json
\ No newline at end of file @@ -9,6 +9,7 @@ There is a timeline view of your own posts, as well as a simple 'compose post' p The entire design is inside a single theme file [microblog.css](microblog.css) and can be modified easily. The site HTML is pretty straightforward and should be easy to style. The app requires at least PHP 5.5 and was tested on 7.0 +For crossposting to twitter, the app uses code from [J7mbo/twitter-api-php](https://github.com/J7mbo/twitter-api-php) ### Installation @@ -16,6 +17,7 @@ The app requires at least PHP 5.5 and was tested on 7.0 - edit [config.php](config.php) and adjust the settings if you like (at least set a new password!) - edit [.htaccess](.htaccess) and set `RewriteBase` to a path matching your installation directory - optional: modify the theme file [microblog.css](microblog.css) +- optional: enable crossposting to twitter by filling in app credentials in [config.php](config.php#L32-L35) (instructions there) ### To Do @@ -26,7 +26,14 @@ $config = array( 'admin_user' => 'admin', 'admin_pass' => 'dove-life-bird-lust', 'cookie_life' => 60*60*24*7*4, // cookie life in seconds - 'ping' => true // enable automatic pinging of the micro.blog service + 'ping' => true, // enable automatic pinging of the micro.blog service + 'crosspost_to_twitter' => false, // set this to true to automatically crosspost to a twitter account (requires app credentials, see below) + 'twitter' => array( // get your tokens over at https://dev.twitter.com/apps + 'oauth_access_token' => '', + 'oauth_access_token_secret' => '', + 'consumer_key' => '', + 'consumer_secret' => '' + ) ); //connect or create the database and tables diff --git a/functions.php b/functions.php index aad239a..19325d1 100644 --- a/functions.php +++ b/functions.php @@ -118,4 +118,24 @@ function rebuild_feed($amount=10) { if(file_put_contents(ROOT.DS.'feed.json', json_encode($feed, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES))) { return true; } else return false; +} + +function twitter_post_status($status='') { + global $config; + require_once(ROOT.DS.'twitter_api.php'); + + if(empty($status)) return array('errors' => 1); + if(empty($config['twitter']['oauth_access_token']) || + empty($config['twitter']['oauth_access_token_secret']) || + empty($config['twitter']['consumer_key']) || + empty($config['twitter']['consumer_secret'])) return array('errors' => 2); + + $url = 'https://api.twitter.com/1.1/statuses/update.json'; + $postfields = array( + 'status' => $status, + 'trim_user' => 1 + ); + + $twitter = new TwitterAPIExchange($config['twitter']); + return $twitter->buildOauth($url, 'POST')->setPostfields($postfields)->performRequest(); }
\ No newline at end of file diff --git a/postform.inc.php b/postform.inc.php index 4a7e20b..f41db2e 100644 --- a/postform.inc.php +++ b/postform.inc.php @@ -26,7 +26,14 @@ ); rebuild_feed(); - if($config['ping'] === true) ping_microblog(); + if($config['ping'] == true) ping_microblog(); + if($config['crosspost_to_twitter'] == true) { + $twitter_response = json_decode(twitter_post_status($_POST['message']), true); + + if(!empty($twitter_response['errors'])) { + $message['message'] .= ' (But crossposting to twitter failed!)'; + } + } } } @@ -34,6 +41,7 @@ <html lang="<?= $config['language'] ?>" class="postform"> <head> <title>micro.blog</title> + <meta name="viewport" content="width=device-width" /> <link rel="stylesheet" href="<?= $config['url'] ?>/microblog.css" /> </head> <body> diff --git a/single.inc.php b/single.inc.php index 8c33097..1e97179 100644 --- a/single.inc.php +++ b/single.inc.php @@ -9,6 +9,7 @@ <html lang="<?= $config['language'] ?>" class="post"> <head> <title>micro.blog</title> + <meta name="viewport" content="width=device-width" /> <link rel="stylesheet" href="<?= $config['url'] ?>/microblog.css" /> </head> <body> diff --git a/timeline.inc.php b/timeline.inc.php index 773435e..c36b3bd 100644 --- a/timeline.inc.php +++ b/timeline.inc.php @@ -20,6 +20,7 @@ <html lang="<?= $config['language'] ?>" class="timeline"> <head> <title>micro.blog</title> + <meta name="viewport" content="width=device-width" /> <link rel="alternate" type="application/json" title="JSON Feed" href="<?= $config['url'] ?>/feed.json" /> <link rel="stylesheet" href="<?= $config['url'] ?>/microblog.css" /> </head> diff --git a/twitter_api.php b/twitter_api.php new file mode 100644 index 0000000..ea60a4c --- /dev/null +++ b/twitter_api.php @@ -0,0 +1,410 @@ +<?php + +/** + * Twitter-API-PHP : Simple PHP wrapper for the v1.1 API + * + * PHP version 5.3.10 + * + * @category Awesomeness + * @package Twitter-API-PHP + * @author James Mallison <me@j7mbo.co.uk> + * @license MIT License + * @version 1.0.4 + * @link http://github.com/j7mbo/twitter-api-php + */ +class TwitterAPIExchange +{ + /** + * @var string + */ + private $oauth_access_token; + + /** + * @var string + */ + private $oauth_access_token_secret; + + /** + * @var string + */ + private $consumer_key; + + /** + * @var string + */ + private $consumer_secret; + + /** + * @var array + */ + private $postfields; + + /** + * @var string + */ + private $getfield; + + /** + * @var mixed + */ + protected $oauth; + + /** + * @var string + */ + public $url; + + /** + * @var string + */ + public $requestMethod; + + /** + * The HTTP status code from the previous request + * + * @var int + */ + protected $httpStatusCode; + + /** + * Create the API access object. Requires an array of settings:: + * oauth access token, oauth access token secret, consumer key, consumer secret + * These are all available by creating your own application on dev.twitter.com + * Requires the cURL library + * + * @throws \RuntimeException When cURL isn't loaded + * @throws \InvalidArgumentException When incomplete settings parameters are provided + * + * @param array $settings + */ + public function __construct(array $settings) + { + if (!function_exists('curl_init')) + { + throw new RuntimeException('TwitterAPIExchange requires cURL extension to be loaded, see: http://curl.haxx.se/docs/install.html'); + } + + if (!isset($settings['oauth_access_token']) + || !isset($settings['oauth_access_token_secret']) + || !isset($settings['consumer_key']) + || !isset($settings['consumer_secret'])) + { + throw new InvalidArgumentException('Incomplete settings passed to TwitterAPIExchange'); + } + + $this->oauth_access_token = $settings['oauth_access_token']; + $this->oauth_access_token_secret = $settings['oauth_access_token_secret']; + $this->consumer_key = $settings['consumer_key']; + $this->consumer_secret = $settings['consumer_secret']; + } + + /** + * Set postfields array, example: array('screen_name' => 'J7mbo') + * + * @param array $array Array of parameters to send to API + * + * @throws \Exception When you are trying to set both get and post fields + * + * @return TwitterAPIExchange Instance of self for method chaining + */ + public function setPostfields(array $array) + { + if (!is_null($this->getGetfield())) + { + throw new Exception('You can only choose get OR post fields (post fields include put).'); + } + + if (isset($array['status']) && substr($array['status'], 0, 1) === '@') + { + $array['status'] = sprintf("\0%s", $array['status']); + } + + foreach ($array as $key => &$value) + { + if (is_bool($value)) + { + $value = ($value === true) ? 'true' : 'false'; + } + } + + $this->postfields = $array; + + // rebuild oAuth + if (isset($this->oauth['oauth_signature'])) + { + $this->buildOauth($this->url, $this->requestMethod); + } + + return $this; + } + + /** + * Set getfield string, example: '?screen_name=J7mbo' + * + * @param string $string Get key and value pairs as string + * + * @throws \Exception + * + * @return \TwitterAPIExchange Instance of self for method chaining + */ + public function setGetfield($string) + { + if (!is_null($this->getPostfields())) + { + throw new Exception('You can only choose get OR post / post fields.'); + } + + $getfields = preg_replace('/^\?/', '', explode('&', $string)); + $params = array(); + + foreach ($getfields as $field) + { + if ($field !== '') + { + list($key, $value) = explode('=', $field); + $params[$key] = $value; + } + } + + $this->getfield = '?' . http_build_query($params, '', '&'); + + return $this; + } + + /** + * Get getfield string (simple getter) + * + * @return string $this->getfields + */ + public function getGetfield() + { + return $this->getfield; + } + + /** + * Get postfields array (simple getter) + * + * @return array $this->postfields + */ + public function getPostfields() + { + return $this->postfields; + } + + /** + * Build the Oauth object using params set in construct and additionals + * passed to this method. For v1.1, see: https://dev.twitter.com/docs/api/1.1 + * + * @param string $url The API url to use. Example: https://api.twitter.com/1.1/search/tweets.json + * @param string $requestMethod Either POST or GET + * + * @throws \Exception + * + * @return \TwitterAPIExchange Instance of self for method chaining + */ + public function buildOauth($url, $requestMethod) + { + if (!in_array(strtolower($requestMethod), array('post', 'get', 'put', 'delete'))) + { + throw new Exception('Request method must be either POST, GET or PUT or DELETE'); + } + + $consumer_key = $this->consumer_key; + $consumer_secret = $this->consumer_secret; + $oauth_access_token = $this->oauth_access_token; + $oauth_access_token_secret = $this->oauth_access_token_secret; + + $oauth = array( + 'oauth_consumer_key' => $consumer_key, + 'oauth_nonce' => time(), + 'oauth_signature_method' => 'HMAC-SHA1', + 'oauth_token' => $oauth_access_token, + 'oauth_timestamp' => time(), + 'oauth_version' => '1.0' + ); + + $getfield = $this->getGetfield(); + + if (!is_null($getfield)) + { + $getfields = str_replace('?', '', explode('&', $getfield)); + + foreach ($getfields as $g) + { + $split = explode('=', $g); + + /** In case a null is passed through **/ + if (isset($split[1])) + { + $oauth[$split[0]] = urldecode($split[1]); + } + } + } + + $postfields = $this->getPostfields(); + + if (!is_null($postfields)) { + foreach ($postfields as $key => $value) { + $oauth[$key] = $value; + } + } + + $base_info = $this->buildBaseString($url, $requestMethod, $oauth); + $composite_key = rawurlencode($consumer_secret) . '&' . rawurlencode($oauth_access_token_secret); + $oauth_signature = base64_encode(hash_hmac('sha1', $base_info, $composite_key, true)); + $oauth['oauth_signature'] = $oauth_signature; + + $this->url = $url; + $this->requestMethod = $requestMethod; + $this->oauth = $oauth; + + return $this; + } + + /** + * Perform the actual data retrieval from the API + * + * @param boolean $return If true, returns data. This is left in for backward compatibility reasons + * @param array $curlOptions Additional Curl options for this request + * + * @throws \Exception + * + * @return string json If $return param is true, returns json data. + */ + public function performRequest($return = true, $curlOptions = array()) + { + if (!is_bool($return)) + { + throw new Exception('performRequest parameter must be true or false'); + } + + $header = array($this->buildAuthorizationHeader($this->oauth), 'Expect:'); + + $getfield = $this->getGetfield(); + $postfields = $this->getPostfields(); + + if (in_array(strtolower($this->requestMethod), array('put', 'delete'))) + { + $curlOptions[CURLOPT_CUSTOMREQUEST] = $this->requestMethod; + } + + $options = $curlOptions + array( + CURLOPT_HTTPHEADER => $header, + CURLOPT_HEADER => false, + CURLOPT_URL => $this->url, + CURLOPT_RETURNTRANSFER => true, + CURLOPT_TIMEOUT => 10, + ); + + if (!is_null($postfields)) + { + $options[CURLOPT_POSTFIELDS] = http_build_query($postfields, '', '&'); + } + else + { + if ($getfield !== '') + { + $options[CURLOPT_URL] .= $getfield; + } + } + + $feed = curl_init(); + curl_setopt_array($feed, $options); + $json = curl_exec($feed); + + $this->httpStatusCode = curl_getinfo($feed, CURLINFO_HTTP_CODE); + + if (($error = curl_error($feed)) !== '') + { + curl_close($feed); + + throw new \Exception($error); + } + + curl_close($feed); + + return $json; + } + + /** + * Private method to generate the base string used by cURL + * + * @param string $baseURI + * @param string $method + * @param array $params + * + * @return string Built base string + */ + private function buildBaseString($baseURI, $method, $params) + { + $return = array(); + ksort($params); + + foreach($params as $key => $value) + { + $return[] = rawurlencode($key) . '=' . rawurlencode($value); + } + + return $method . "&" . rawurlencode($baseURI) . '&' . rawurlencode(implode('&', $return)); + } + + /** + * Private method to generate authorization header used by cURL + * + * @param array $oauth Array of oauth data generated by buildOauth() + * + * @return string $return Header used by cURL for request + */ + private function buildAuthorizationHeader(array $oauth) + { + $return = 'Authorization: OAuth '; + $values = array(); + + foreach($oauth as $key => $value) + { + if (in_array($key, array('oauth_consumer_key', 'oauth_nonce', 'oauth_signature', + 'oauth_signature_method', 'oauth_timestamp', 'oauth_token', 'oauth_version'))) { + $values[] = "$key=\"" . rawurlencode($value) . "\""; + } + } + + $return .= implode(', ', $values); + return $return; + } + + /** + * Helper method to perform our request + * + * @param string $url + * @param string $method + * @param string $data + * @param array $curlOptions + * + * @throws \Exception + * + * @return string The json response from the server + */ + public function request($url, $method = 'get', $data = null, $curlOptions = array()) + { + if (strtolower($method) === 'get') + { + $this->setGetfield($data); + } + else + { + $this->setPostfields($data); + } + + return $this->buildOauth($url, $method)->performRequest(true, $curlOptions); + } + + /** + * Get the HTTP status code for the previous request + * + * @return integer + */ + public function getHttpStatusCode() + { + return $this->httpStatusCode; + } +}
\ No newline at end of file |