-
Notifications
You must be signed in to change notification settings - Fork 29
/
ImageCaptcha.py
571 lines (500 loc) · 32.8 KB
/
ImageCaptcha.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
import requests
import time
import hashlib
import os
import asyncio
import aiohttp
import base64
from requests.adapters import HTTPAdapter
from python_rucaptcha.config import app_key
from python_rucaptcha.errors import RuCaptchaError
from python_rucaptcha.result_handler import get_sync_result, get_async_result
from python_rucaptcha.decorators import api_key_check, service_check
class ImageCaptcha:
"""
Данный метод подходит как для загрузки и решения обычной капчи
так и для большой капчи.
Требуется передать API ключ сайта, ссылку на изображение и,по желанию, время ожидания решения капчи
Подробней информацию смотрите в методе 'captcha_handler'
"""
def __init__(self, rucaptcha_key: str, sleep_time: int = 5, save_format: str = 'temp',
service_type: str = '2captcha', img_clearing: bool = True, img_path: str = 'PythonRuCaptchaImages',
**kwargs):
"""
Инициализация нужных переменных, создание папки для изображений и кэша
После завершения работы - удалются временные фалйы и папки
:param rucaptcha_key: АПИ ключ капчи из кабинета пользователя
:param sleep_time: Вермя ожидания решения капчи
:param save_format: Формат в котором будет сохраняться изображение, либо как временный фпйл - 'temp',
либо как обычное изображение в папку созданную библиотекой - 'const'.
:param service_type: URL с которым будет работать программа, возможен вариант "2captcha"(стандартный)
и "rucaptcha"
:param img_path: Папка для сохранения изображений капчи;
:param img_clearing: True - удалять файл после решения, False - не удалять файл после решения;
:param kwargs: Служит для передачи необязательных параметров в пайлоад для запроса к RuCaptcha
Подробней с примерами можно ознакомиться в 'CaptchaTester/image_captcha_example.py'
"""
# время ожидания решения капчи
self.sleep_time = sleep_time
# тип URL на с которым будет работать библиотека
self.service_type = service_type
# проверяем переданный параметр способа сохранения капчи
if save_format in ['const', 'temp']:
self.save_format = save_format
# если файл сохраняется в папку, берём параметр названия папки и очистк/не очистки папки от капч
if self.save_format is 'const':
# очищаем папку после решения капчи - True, сохраняем все файлы - False
self.img_clearing = img_clearing
# название папки для сохранения файлов капчи
self.img_path = img_path
else:
raise ValueError('\nПередан неверный формат сохранения файла изображения. '
f'\n\tВозможные варинты: `temp` и `const`. Вы передали - `{save_format}`'
'\nWrong `save_format` parameter. Valid params: `const` or `temp`.'
f'\n\tYour param - `{save_format}`')
# пайлоад POST запроса на отправку капчи на сервер
self.post_payload = {"key": rucaptcha_key,
"method": "base64",
"json": 1,
"soft_id": app_key,
}
# Если переданы ещё параметры - вносим их в post_payload
if kwargs:
for key in kwargs:
self.post_payload.update({key: kwargs[key]})
# пайлоад GET запроса на получение результата решения капчи
self.get_payload = {'key': rucaptcha_key,
'action': 'get',
'json': 1,
}
# создаём сессию
self.session = requests.Session()
# выставляем кол-во попыток подключения к серверу при ошибке
self.session.mount('http://', HTTPAdapter(max_retries = 5))
self.session.mount('https://', HTTPAdapter(max_retries = 5))
def __image_temp_saver(self, content: bytes):
"""
Метод сохраняет файл изображения как временный и отправляет его сразу на сервер для расшифровки.
:return: Возвращает ID капчи из сервиса
"""
captcha_id = None
try:
# Отправляем на рукапча изображение капчи и другие парметры,
# в результате получаем JSON ответ с номером решаемой капчи и получая ответ - извлекаем номер
self.post_payload.update({"body": base64.b64encode(content).decode('utf-8')})
captcha_id = self.session.post(self.url_request, data = self.post_payload).json()
except Exception as error:
self.result.update({'error': True,
'errorBody': {
'text': error,
'id': -1
}
}
)
finally:
return captcha_id
def __image_const_saver(self, content: bytes):
"""
Метод создаёт папку и сохраняет в неё изображение, затем передаёт его на расшифровку и удалет файл.
:param content: Файл для сохранения;
:return: Возвращает ID капчи из сервиса
"""
captcha_id = None
try:
# Высчитываем хэш изображения, для того что бы сохранить его под уникальным именем
image_hash = hashlib.sha224(content).hexdigest()
# создаём папку для сохранения капч
if not os.path.exists(self.img_path):
os.mkdir(self.img_path)
# сохраняем в папку изображение
with open(os.path.join(self.img_path, f'im-{image_hash}.png'), 'wb') as out_image:
out_image.write(content)
with open(os.path.join(self.img_path, f'im-{image_hash}.png'), 'rb') as captcha_image:
# Отправляем на рукапча изображение капчи и другие парметры,
# в результате получаем JSON ответ с номером решаемой капчи и получая ответ - извлекаем номер
self.post_payload.update({"body": base64.b64encode(captcha_image.read()).decode('utf-8')})
captcha_id = self.session.post(self.url_request, data = self.post_payload).json()
# если передано True для удаления файла капчи после решения
if self.img_clearing:
# удаляем файл капчи
os.remove(os.path.join(self.img_path, f"im-{image_hash}.png"))
except (IOError, FileNotFoundError) as error:
self.result.update({'error': True,
'errorBody': {
'text': error,
'id': -1
}
}
)
except Exception as error:
self.result.update({'error': True,
'errorBody': {
'text': error,
'id': -1
}
}
)
finally:
return captcha_id
def __local_image_captcha(self, content: str, content_type: str = "file"):
"""
Метод получает в качестве параметра ссылку на локальный файл(или файл в кодировке base64), считывает изображение и отправляет его на РуКапчу
для проверки и получения её ID
:param content: Ссылка на локальный файл
:param content_type: Тип передаваемого файла, Может быть `file`(если передан локальный адрес) или
`base64`(если передано изображение в кодировке base64)
:return: ID капчи в сервисе
"""
captcha_id = None
try:
# пробуем открыть файл, закодировать в base64, затем вносим закодированный файл в post_payload для отправки на
# рукапчу для решения
if content_type == 'file':
with open(content, 'rb') as captcha_image:
self.post_payload.update({"body": base64.b64encode(captcha_image.read()).decode('utf-8')})
# вносим закодированный файл в post_payload для отправки на рукапчу для решения
elif content_type == "base64":
self.post_payload.update({"body": content})
else:
raise ValueError(f'Передан неверный тип контента! Допустимые: `file` и `base64`. '
f'Вы передали: `{content_type}`')
# Отправляем на рукапча изображение капчи и другие парметры,
# в результате получаем JSON ответ с номером решаемой капчи и получая ответ - извлекаем номер
captcha_id = self.session.post(self.url_request, data = self.post_payload).json()
except (IOError, FileNotFoundError) as error:
self.result.update({'error': True,
'errorBody': {
'text': error,
'id': -1
}
}
)
except Exception as error:
self.result.update({'error': True,
'errorBody': {
'text': error,
'id': -1
}
}
)
finally:
return captcha_id
@api_key_check
@service_check
def captcha_handler(self, captcha_link: str = None, captcha_file: str = None, captcha_base64: str = None, **kwargs):
"""
Метод получает от вас ссылку на изображение, скачивает его, отправляет изображение на сервер
RuCaptcha, дожидается решения капчи и вовзращает вам результат
:param captcha_link: Ссылка на изображение
:param captcha_file: Адрес(локальный) по которому находится изображение для отправки на расшифровку
:param captcha_base64: Изображение переданное в кодировке base64
:param kwargs: Параметры для библиотеки `requests`
:return: Ответ на капчу в виде JSON строки с полями:
captchaSolve - решение капчи,
taskId - находится Id задачи на решение капчи, можно использовать при жалобах и прочем,
error - False - если всё хорошо, True - если есть ошибка,
errorBody - полная информация об ошибке:
{
text - Развернётое пояснение ошибки
id - уникальный номер ошибка в ЭТОЙ бибилотеке
}
"""
# result, url_request, url_response - задаются в декораторе `service_check`, после проверки переданного названия
# если передана локальная ссылка на файл
if captcha_file:
captcha_id = self.__local_image_captcha(captcha_file)
# если передан файл в кодировке base64
elif captcha_base64:
captcha_id = self.__local_image_captcha(captcha_base64, content_type = "base64")
# если передан URL
elif captcha_link:
try:
content = self.session.get(url = captcha_link, **kwargs).content
except Exception as error:
self.result.update({'error': True,
'errorBody': {
'text': error,
'id': -1
}
}
)
return self.result
# согласно значения переданного параметра выбираем функцию для сохранения изображения
if self.save_format == 'const':
captcha_id = self.__image_const_saver(content)
elif self.save_format == 'temp':
captcha_id = self.__image_temp_saver(content)
else:
# если не передан ни один из параметров
self.result.update({'error': True,
'errorBody': 'You did not send any file local link or URL.',
}
)
return self.result
# проверяем наличие ошибок при скачивании/передаче файла на сервер
if self.result['error']:
return self.result
# если вернулся ответ с ошибкой то записываем её и возвращаем результат
elif captcha_id['status'] is 0:
self.result.update({'error': True,
'errorBody': RuCaptchaError().errors(captcha_id['request'])
}
)
return self.result
# иначе берём ключ отправленной на решение капчи и ждём решения
else:
captcha_id = captcha_id['request']
# вписываем в taskId ключ отправленной на решение капчи
self.result.update({"taskId": captcha_id})
# обновляем пайлоад, вносим в него ключ отправленной на решение капчи
self.get_payload.update({'id': captcha_id})
# если передан параметр `pingback` - не ждём решения капчи а возвращаем незаполненный ответ
if self.post_payload.get('pingback'):
return self.get_payload
else:
# Ожидаем решения капчи
time.sleep(self.sleep_time)
return get_sync_result(get_payload=self.get_payload,
sleep_time = self.sleep_time,
url_response = self.url_response,
result = self.result)
class aioImageCaptcha:
"""
Данный асинхронный метод подходит как для загрузки и решения обычной капчи
так и для большой капчи.
Требуется передать API ключ сайта, ссылку на изображение и,по желанию, время ожидания решения капчи
Подробней информацию смотрите в методе 'captcha_handler'
"""
def __init__(self, rucaptcha_key: str, sleep_time: int = 5, save_format: str = 'temp',
service_type: str = '2captcha', img_clearing: bool = True, img_path: str = 'PythonRuCaptchaImages',
**kwargs):
"""
Инициализация нужных переменных, создание папки для изображений и кэша
После завершения работы - удалются временные фалйы и папки
:param rucaptcha_key: АПИ ключ капчи из кабинета пользователя
:param sleep_time: Вермя ожидания решения капчи
:param save_format: Формат в котором будет сохраняться изображение, либо как временный фпйл - 'temp',
либо как обычное изображение в папку созданную библиотекой - 'const'.
:param service_type: URL с которым будет работать программа, возможен вариант "2captcha"(стандартный)
и "rucaptcha"
:param img_path: Папка для сохранения изображений капчи;
:param img_clearing: True - удалять файл после решения, False - не удалять файл после решения;
:param kwargs: Служит для передачи необязательных параметров в пайлоад для запроса к RuCaptcha
Подробней с примерами можно ознакомиться в 'CaptchaTester/image_captcha_example.py'
"""
# время ожидания решения капчи
self.sleep_time = sleep_time
# тип URL на с которым будет работать библиотека
self.service_type = service_type
# проверяем переданный параметр способа сохранения капчи
if save_format in ['const', 'temp']:
self.save_format = save_format
# если файл сохраняется в папку, берём параметр названия папки и очистк/не очистки папки от капч
if self.save_format is 'const':
# очищаем папку после решения капчи - True, сохраняем все файлы - False
self.img_clearing = img_clearing
# название папки для сохранения файлов капчи
self.img_path = img_path
else:
raise ValueError('\nПередан неверный формат сохранения файла изображения. '
f'\n\tВозможные варинты: `temp` и `const`. Вы передали - `{save_format}`'
'\nWrong `save_format` parameter. Valid params: `const` or `temp`.'
f'\n\tYour param - `{save_format}`')
# пайлоад POST запроса на отправку капчи на сервер
self.post_payload = {"key": rucaptcha_key,
"method": "base64",
"json": 1,
"soft_id": app_key,
}
# Если переданы ещё параметры - вносим их в post_payload
if kwargs:
for key in kwargs:
self.post_payload.update({key: kwargs[key]})
# пайлоад GET запроса на получение результата решения капчи
self.get_payload = {'key': rucaptcha_key,
'action': 'get',
'json': 1,
}
async def __image_temp_saver(self, content: bytes):
"""
Метод сохраняет файл изображения как временный и отправляет его сразу на сервер для расшифровки.
:return: Возвращает ID капчи из сервиса
"""
captcha_id = None
try:
self.post_payload.update({"body": base64.b64encode(content).decode('utf-8')})
async with aiohttp.ClientSession() as session:
async with session.post(self.url_request, data = self.post_payload) as resp:
captcha_id = await resp.json()
except Exception as error:
self.result.update({'error': True,
'errorBody': {
'text': error,
'id': -1
}
}
)
finally:
return captcha_id
async def __image_const_saver(self, content: bytes):
"""
Метод создаёт папку и сохраняет в неё изображение, затем передаёт его на расшифровку и удалет файл.
:return: Возвращает ID капчи из сервиса
"""
captcha_id = None
try:
if not os.path.exists(self.img_path):
os.mkdir(self.img_path)
# Высчитываем хэш изображения, для того что бы сохранить его под уникальным именем
image_hash = hashlib.sha224(content).hexdigest()
with open(os.path.join(self.img_path, f'im-{image_hash}.png'), 'wb') as out_image:
out_image.write(content)
with open(os.path.join(self.img_path, f'im-{image_hash}.png'), 'rb') as captcha_image:
# Отправляем на рукапча изображение капчи и другие парметры,
# в результате получаем JSON ответ с номером решаемой капчи и получая ответ - извлекаем номер
self.post_payload.update({"body": base64.b64encode(captcha_image.read()).decode('utf-8')})
async with aiohttp.ClientSession() as session:
async with session.post(self.url_request, data = self.post_payload) as resp:
captcha_id = await resp.json()
# если передано True для удаления файла капчи после решения
if self.img_clearing:
# удаляем файл капчи
os.remove(os.path.join(self.img_path, f"im-{image_hash}.png"))
except (IOError, FileNotFoundError) as error:
self.result.update({'error': True,
'errorBody': {
'text': error,
'id': -1
}
}
)
except Exception as error:
self.result.update({'error': True,
'errorBody': {
'text': error,
'id': -1
}
}
)
finally:
return captcha_id
async def __local_image_captcha(self, content: str, content_type: str = 'file'):
"""
Метод получает в качестве параметра ссылку на локальный файл(или файл в кодировке base64), считывает изображение и отправляет его на РуКапчу
для проверки и получения её ID
:param content: Ссылка на локальный файл
:param content_type: Тип передаваемого файла, Может быть `file`(если передан локальный адрес) или
`base64`(если передано изображение в кодировке base64)
:return: ID капчи в сервисе
"""
captcha_id = None
try:
if content_type == 'file':
with open(content, 'rb') as captcha_image:
# Отправляем на рукапча изображение капчи и другие парметры,
# в результате получаем JSON ответ с номером решаемой капчи и получая ответ - извлекаем номер
self.post_payload.update({"body": base64.b64encode(captcha_image.read()).decode('utf-8')})
elif content_type == "base64":
self.post_payload.update({"body": content})
else:
raise ValueError(f'Передан неверный тип контента! Допустимые: `file` и `base64`. '
f'Вы передали: `{content_type}`')
captcha_id = requests.post(self.url_request, data = self.post_payload).json()
except (IOError, FileNotFoundError) as error:
self.result.update({'error': True,
'errorBody': {
'text': error,
'id': -1
}
}
)
except Exception as error:
self.result.update({'error': True,
'errorBody': {
'text': error,
'id': -1
}
}
)
finally:
return captcha_id
@api_key_check
@service_check
async def captcha_handler(self, captcha_link: str = None, captcha_file: str = None, captcha_base64: str = None,
proxy: str = None):
"""
Метод получает от вас ссылку на изображение, скачивает его, отправляет изображение на сервер
RuCaptcha, дожидается решения капчи и вовзращает вам результат
:param captcha_link: Ссылка на изображение
:param captcha_file: Адрес(локальный) по которому находится изображение для отправки на расшифровку
:param captcha_base64: Изображение переданное в кодировке base64
:param proxy: Прокси для aiohttp модуля
:return: Ответ на капчу в виде JSON строки с полями:
captchaSolve - решение капчи,
taskId - находится Id задачи на решение капчи, можно использовать при жалобах и прочем,
error - False - если всё хорошо, True - если есть ошибка,
errorBody - полная информация об ошибке:
{
text - Развернётое пояснение ошибки
id - уникальный номер ошибка в ЭТОЙ бибилотеке
}
"""
# result, url_request, url_response - задаются в декораторе `service_check`, после проверки переданного названия
# если передана локальная ссылка на файл - работаем с ним
if captcha_file:
captcha_id = await self.__local_image_captcha(captcha_file)
# если передан файл в кодировке base64
elif captcha_base64:
captcha_id = await self.__local_image_captcha(captcha_base64, content_type="base64")
elif captcha_link:
try:
async with aiohttp.ClientSession() as session:
async with session.get(url = captcha_link, proxy = proxy) as resp:
content = await resp.content.read()
except Exception as error:
self.result.update({'error': True,
'errorBody': {
'text': error,
'id': -1
}
}
)
return self.result
# согласно значения переданного параметра выбираем функцию для сохранения изображения
if self.save_format == 'const':
captcha_id = await self.__image_const_saver(content)
elif self.save_format == 'temp':
captcha_id = await self.__image_temp_saver(content)
else:
self.result.update({'error': True,
'errorBody': 'You did not send any file local link or URL.',
}
)
return self.result
# проверяем наличие ошибок при скачивании/передаче файла на сервер
if self.result['error']:
return self.result
# если вернулся ответ с ошибкой то записываем её и возвращаем результат
elif captcha_id['status'] is 0:
self.result.update({'error': True,
'errorBody': RuCaptchaError().errors(captcha_id['request'])
}
)
return self.result
# иначе берём ключ отправленной на решение капчи и ждём решения
else:
captcha_id = captcha_id['request']
# вписываем в taskId ключ отправленной на решение капчи
self.result.update({"taskId": captcha_id})
# обновляем пайлоад, вносим в него ключ отправленной на решение капчи
self.get_payload.update({'id': captcha_id})
# если передан параметр `pingback` - не ждём решения капчи а возвращаем незаполненный ответ
if self.post_payload.get('pingback'):
return self.get_payload
else:
# Ожидаем решения капчи
await asyncio.sleep(self.sleep_time)
return await get_async_result(get_payload = self.get_payload,
sleep_time = self.sleep_time,
url_response = self.url_response,
result = self.result)