Заметка одиннадцатая(сетевые возможности)

Сетевые возможности ruby мы рассмотри на примере написания web-servera.

Итак, начнём=)

Для начала нам понадобится http://www.ruby-doc.org/core/ и далее, при написании хороших программ – всегда будем смотреть именно туда, чтобы не изобретать велосипед. Многие читатели моего блога, думаю, знаю про WebRick( это уже написанный полнофункциональный веб сервер на языке ruby), о нём можно почитать  здесь. Но мы напишем свой web-сервер, дабы показать возможности ruby.

Нам понадобятся две библиотеки( ‘socket’ и ‘logger’). Первая, как вы догадались для работы с сокетами, вторая для логгирования.

Назовём наш класс HttpServer и добавим переменные инициализации:

1. class HttpServer
2. def initialize(session, request, basepath)
3. @session = session
4. @request = request
5. @basepath = basepath
6. end
7. end

session – переменная, в которую пишется наша сессия.

request – переменная, куда пишется запрос, который приходит от браузера.

basepath – каталог, где лежит наш сайт.

Начнём разбирать “путь запроса файла”. Почитать про заголовки, можно здесь

1. def getfullpath()
2. file_name = @request =~ /^GET\s+(\S+)/i ? $1 : “/”
3. file_name = File.expand_path(file_name, @basepath)
4. file_name << “index.html” if File.directory?(file_name)
5. return file_name
6. end

Используя регулярное выражение мы получаем имя файла и путь до него, который нужный отдать серверу.

Далее нам нужен полный путь файла, чтоб найти его на жёстком диске. Идём в документацию, смотрим что у нас есть по работе с файлами, опа, нашли expand_path – это именно то, что нам нужно, используя его, получаем полный пусть к файлу.

А если у нас запрашивается не файл, а папка? – выход прост – проверяем, запрашивается ли дирректория? – если да, то отдаём “index.html”.

Теперь надо расмотреть то, как мы будем отдавать файлы браузеру. Для этого нам надо почитать ещё это.

1. def serve()
2. temp = getfullpath()
3. begin
4. if File.exist?(@basepath + temp) and File.file?(@basepath + temp)
5. @session.puts “HTTP/1.1 200 OK\r\nDate: #{Time.now.localtime.strftime(“%a, %d %b %Y %H:%M:%S GTM“)}\r\nServer: KriM\r\nContent-type: #{getcontenttype(temp)}; charset=utf-8\r\n\r\n”
6. @session.puts IO.read(@basepath + temp)
7. @session.puts Time.now.localtime.strftime(“%a, %d %b %Y %H:%M:%S GTM”)
8. else
9. @session.puts “HTTP/1.1 404 Object Not Found\r\nServer: KriM\r\n\r\n”
10. @session.puts “page not found, 404″
11. end
12. ensure
13. @session.close
14. end
15. end

Записываем в temp путь к файлу, Если файл есть, то отправляем браузеру состояние 200(я надеюсь вы почитали об этом). Ну и дальше по стандарту – время, имя сервера, тип данных(для этого есть функция getcontenttype – о ней чуть позже), затем кодировка.

Об классе IO я рассказывал в предыдущих заметках. Читаем файл и печатаем его в сессию(данные отправляются в бразуер), далее я, для проверки просто вывожу время.

Если файл не найден на жёстком диске, то надо вывести ошибку 404, сказать пользователю о том, что файл не найден на сервере.

Ну и закрываем сессию=) Если вы читали предыдущую заметку, то думаю не надо объяснять зачем нужна конструкция вида begin – ensure – end.

Рассмотрим функцию getcontenttype. Она очень простая, получаем тип запрашиваемого файла, создаём хэш массив(смотрим предыдущие заметки) с типами файлов(ключ) и возвращаемым типом контента(значение)

1. def getcontenttype(path)
2. ext = File.extname(path)
3. type = {
4. “.html” => “text/html”,
5. “.htm” => “text/plain”,
6. “.txt” => “text/plain”,
7. “.css” => “text/css”,
8. “.jpeg” => “image/jpeg”,
9. “.jpg” => “image/jpeg”,
10. “.gif” => “image/gif”,
11. “.bmp” => “image/bmp”,
12. “.rb” => “text/plain”,
13. “.xml” => “text/xml”,
14. “.xsl” => “text/xml”
15. }
16. return type[ext] || “application/octet-stream”
17. end

Объясню лишь последнюю строчку, возвращаем значение по ключу, или возвращаем “application/octet-stream” , если такого ключа нету.

Всё, класс написан=)

1. class HttpServer
2. def initialize(session, request, basepath)
3. @session = session
4. @request = request
5. @basepath = basepath
6. end
8. def getfullpath()
9. file_name = @request =~ /^GET\s+(\S+)/i ? $1 : “/”
10. file_name = File.expand_path(file_name, @basepath)
11. file_name << “index.html” if File.directory?(file_name)
12. return file_name
13. end
15. def serve()
16. temp = getfullpath()
17. begin
18. if File.exist?(@basepath + temp) and File.file?(@basepath + temp)
19. @session.puts “HTTP/1.1 200 OK\r\nDate: #{Time.now.localtime.strftime(“%a, %d %b %Y %H:%M:%S GTM“)}\r\nServer: KriM\r\nContent-type: #{getcontenttype(temp)}; charset=utf-8\r\n\r\n”
20. @session.puts IO.read(@basepath + temp)
21. @session.puts Time.now.localtime.strftime(“%a, %d %b %Y %H:%M:%S GTM”)
22. else
23. @session.puts “HTTP/1.1 404 Object Not Found\r\nServer: KriM\r\n\r\n”
24. @session.puts “page not found, 404″
25. end
26. ensure
27. @session.close
28. end
29. end
31. def getcontenttype(path)
32. ext = File.extname(path)
33. type = {
34. “.html” => “text/html”,
35. “.htm” => “text/plain”,
36. “.txt” => “text/plain”,
37. “.css” => “text/css”,
38. “.jpeg” => “image/jpeg”,
39. “.jpg” => “image/jpeg”,
40. “.gif” => “image/gif”,
41. “.bmp” => “image/bmp”,
42. “.rb” => “text/plain”,
43. “.xml” => “text/xml”,
44. “.xsl” => “text/xml”
45. }
46. return type[ext] || “application/octet-stream” unless type.key?(ext)
47. end
48. end

Рассмотрим теперь логирование и запуск сервера.

1. $log = Logger.new(‘server.log’)
2. base_path = “/home/krim/web”
3. server = TCPServer.new(‘localhost’, 9191)
5. loop do
6. session = server.accept
7. request = session.gets
8. logs = “\n===================================================\n”
9. logs +=  “#{session.peeraddr[2]} (#{session.peeraddr[3]})\n”
10. logs += “\n#{request}”
11. $log.info(logs)
12. puts logs
14. Thread.start(session, request) do |session, request|
15. HttpServer.new(session, request, base_path).serve()
16. end
17. end

Первые три строчки можно отнести к разряду “конфига”=). Создаём файл, куда будет записываться лог наших запросов и т.д., в base_path запишем путь до нашего каталога с сайтом, ну а в server запишем наш сокет на 9191 порту(вы можете выбрать любой другой, свободный).

Создаём бесконечный цикл, в session мы будем работать с нашей сессией, в request пишем запросы, получаемые от браузера, записываем то, что хотим логировать в переменную logs и пишем в файл server.log с помощью $log.info(logs) + выводим в консоль, то, что залогировали.

Далее опять идём в документаци и смотрим тут.

Смотрим на метод start, аналогичен new. Запускаем поток и сам сервер=). Всё готово=)

Полный код веб-сервера:

1. require ‘socket’
2. require ‘logger’
4. class HttpServer
5. def initialize(session, request, basepath)
6. @session = session
7. @request = request
8. @basepath = basepath
9. end
11. def getfullpath()
12. file_name = @request =~ /^GET\s+(\S+)/i ? $1 : “/”
13. file_name = File.expand_path(file_name, @basepath)
14. file_name << “index.html” if File.directory?(file_name)
15. return file_name
16. end
18. def serve()
19. temp = getfullpath()
20. begin
21. if File.exist?(@basepath + temp) and File.file?(@basepath + temp)
22. @session.puts “HTTP/1.1 200 OK\r\nDate: #{Time.now.localtime.strftime(“%a, %d %b %Y %H:%M:%S GTM“)}\r\nServer: KriM\r\nContent-type: #{getcontenttype(temp)}; charset=utf-8\r\n\r\n”
23. @session.puts IO.read(@basepath + temp)
24. @session.puts Time.now.localtime.strftime(“%a, %d %b %Y %H:%M:%S GTM”)
25. else
26. @session.puts “HTTP/1.1 404 Object Not Found\r\nServer: KriM\r\n\r\n”
27. @session.puts “page not found, 404″
28. end
29. ensure
30. @session.close
31. end
32. end
34. def getcontenttype(path)
35. ext = File.extname(path)
36. type = {
37. “.html” => “text/html”,
38. “.htm” => “text/plain”,
39. “.txt” => “text/plain”,
40. “.css” => “text/css”,
41. “.jpeg” => “image/jpeg”,
42. “.jpg” => “image/jpeg”,
43. “.gif” => “image/gif”,
44. “.bmp” => “image/bmp”,
45. “.rb” => “text/plain”,
46. “.xml” => “text/xml”,
47. “.xsl” => “text/xml”
48. }
49. return type[ext] || “application/octet-stream” unless type.key?(ext)
50. end
51. end
53. $log = Logger.new(‘server.log’)
54. base_path = “/home/krim/web”
55. server = TCPServer.new(‘localhost’, 9191)
57. loop do
58. session = server.accept
59. request = session.gets
60. logs = “\n===================================================\n”
61. logs +=  “#{session.peeraddr[2]} (#{session.peeraddr[3]})\n”
62. logs += “\n#{request}”
63. $log.info(logs)
64. puts logs
66. Thread.start(session, request) do |session, request|
67. HttpServer.new(session, request, base_path).serve()
68. end
69. end